Class: GetUserGroupsResponse
cloudservice.v1.GetUserGroupsResponse
Represents a GetUserGroupsResponse.
Implements
Constructors
constructor
• new GetUserGroupsResponse(properties?): GetUserGroupsResponse
Constructs a new GetUserGroupsResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetUserGroupsResponse | Properties to set |
Returns
Properties
groups
• groups: IUserGroup[]
The list of groups in ascending name order.
Implementation of
nextPageToken
• nextPageToken: string
The next page's token.
Implementation of
IGetUserGroupsResponse.nextPageToken
Methods
toJSON
▸ toJSON(): Object
Converts this GetUserGroupsResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetUserGroupsResponse
Creates a new GetUserGroupsResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetUserGroupsResponse | Properties to set |
Returns
GetUserGroupsResponse instance
decode
▸ decode(reader, length?): GetUserGroupsResponse
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetUserGroupsResponse
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
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 | IGetUserGroupsResponse | 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 | IGetUserGroupsResponse | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetUserGroupsResponse
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 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