Class: GetUserGroupMembersRequest
cloudservice.v1.GetUserGroupMembersRequest
Represents a GetUserGroupMembersRequest.
Implements
Constructors
constructor
• new GetUserGroupMembersRequest(properties?): GetUserGroupMembersRequest
Constructs a new GetUserGroupMembersRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetUserGroupMembersRequest | Properties to set |
Returns
Properties
groupId
• groupId: string
The group id to list members of.
Implementation of
IGetUserGroupMembersRequest.groupId
pageSize
• pageSize: number
The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.
Implementation of
IGetUserGroupMembersRequest.pageSize
pageToken
• pageToken: string
The page token if this is continuing from another response - optional.
Implementation of
IGetUserGroupMembersRequest.pageToken
Methods
toJSON
▸ toJSON(): Object
Converts this GetUserGroupMembersRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetUserGroupMembersRequest
Creates a new GetUserGroupMembersRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetUserGroupMembersRequest | Properties to set |
Returns
GetUserGroupMembersRequest instance
decode
▸ decode(reader, length?): GetUserGroupMembersRequest
Decodes a GetUserGroupMembersRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
GetUserGroupMembersRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetUserGroupMembersRequest
Decodes a GetUserGroupMembersRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetUserGroupMembersRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified GetUserGroupMembersRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupMembersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetUserGroupMembersRequest | GetUserGroupMembersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetUserGroupMembersRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupMembersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetUserGroupMembersRequest | GetUserGroupMembersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetUserGroupMembersRequest
Creates a GetUserGroupMembersRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetUserGroupMembersRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetUserGroupMembersRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a GetUserGroupMembersRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetUserGroupMembersRequest | GetUserGroupMembersRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object