Skip to main content

Class: GetUserGroupsRequest

Represents a GetUserGroupsRequest.

Properties​

displayName​

displayName: string

Filter groups by the display name - optional.

googleGroup?​

optional googleGroup?: $Properties | null

Filter groups by the google group specification - optional.

namespace​

namespace: string

Filter groups by the namespace they have access to - optional.

pageSize​

pageSize: number

The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.

pageToken​

pageToken: string

The page token if this is continuing from another response - optional.

scimGroup?​

optional scimGroup?: $Properties | null

Filter groups by the SCIM group specification - optional.

Methods​

toJSON()​

toJSON(): object

Converts this GetUserGroupsRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GetUserGroupsRequest & $Properties

Creates a new GetUserGroupsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetUserGroupsRequest & $Properties

GetUserGroupsRequest instance

Call Signature​

static create(properties?): GetUserGroupsRequest

Creates a new GetUserGroupsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetUserGroupsRequest

GetUserGroupsRequest instance

decode()​

static decode(reader, length?): GetUserGroupsRequest & $Properties

Decodes a GetUserGroupsRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

GetUserGroupsRequest & $Properties

GetUserGroupsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GetUserGroupsRequest & $Properties

Decodes a GetUserGroupsRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetUserGroupsRequest & $Properties

GetUserGroupsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified GetUserGroupsRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupsRequest.verify|verify messages.

Parameters​

message​

$Properties

GetUserGroupsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified GetUserGroupsRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupsRequest.verify|verify messages.

Parameters​

message​

$Properties

GetUserGroupsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GetUserGroupsRequest

Creates a GetUserGroupsRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GetUserGroupsRequest

GetUserGroupsRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a GetUserGroupsRequest message. Also converts values to other types if specified.

Parameters​

message​

GetUserGroupsRequest

GetUserGroupsRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object