Class: GetUserGroupsResponse
cloudservice.v1.GetUserGroupsResponse
Represents a GetUserGroupsResponse.
Properties
groups
• groups: $Properties[]
The list of groups in ascending name order.
nextPageToken
• nextPageToken: string
The next page's token.
Methods
toJSON
▸ toJSON(): Object
Converts this GetUserGroupsResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetUserGroupsResponse & $Shape
Creates a new GetUserGroupsResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
GetUserGroupsResponse & $Shape
GetUserGroupsResponse instance
▸ create(properties?): GetUserGroupsResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): GetUserGroupsResponse & $Shape
Decodes a GetUserGroupsResponse 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
GetUserGroupsResponse & $Shape
GetUserGroupsResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetUserGroupsResponse & $Shape
Decodes a GetUserGroupsResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetUserGroupsResponse & $Shape
GetUserGroupsResponse
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 GetUserGroupsResponse message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupsResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetUserGroupsResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetUserGroupsResponse message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupsResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetUserGroupsResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetUserGroupsResponse
Creates a GetUserGroupsResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetUserGroupsResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a GetUserGroupsResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetUserGroupsResponse | GetUserGroupsResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object