Class: GetUserGroupsRequest
cloudservice.v1.GetUserGroupsRequest
Represents a GetUserGroupsRequest.
Implements
Constructors
constructor
• new GetUserGroupsRequest(properties?): GetUserGroupsRequest
Constructs a new GetUserGroupsRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetUserGroupsRequest | Properties to set |
Returns
Properties
displayName
• displayName: string
Filter groups by the display name - optional.
Implementation of
IGetUserGroupsRequest.displayName
googleGroup
• Optional googleGroup: null | IGoogleGroupFilter
Filter groups by the google group specification - optional.
Implementation of
IGetUserGroupsRequest.googleGroup
namespace
• namespace: string
Filter groups by the namespace they have access to - optional.
Implementation of
IGetUserGroupsRequest.namespace
pageSize
• pageSize: number
The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.
Implementation of
IGetUserGroupsRequest.pageSize
pageToken
• pageToken: string
The page token if this is continuing from another response - optional.
Implementation of
IGetUserGroupsRequest.pageToken
scimGroup
• Optional scimGroup: null | ISCIMGroupFilter
Filter groups by the SCIM group specification - optional.
Implementation of
IGetUserGroupsRequest.scimGroup
Methods
toJSON
▸ toJSON(): Object
Converts this GetUserGroupsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetUserGroupsRequest
Creates a new GetUserGroupsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetUserGroupsRequest | Properties to set |
Returns
GetUserGroupsRequest instance
decode
▸ decode(reader, length?): GetUserGroupsRequest
Decodes a GetUserGroupsRequest 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
GetUserGroupsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetUserGroupsRequest
Decodes a GetUserGroupsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetUserGroupsRequest
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 GetUserGroupsRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetUserGroupsRequest | GetUserGroupsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetUserGroupsRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUserGroupsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetUserGroupsRequest | GetUserGroupsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetUserGroupsRequest
Creates a GetUserGroupsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetUserGroupsRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetUserGroupsRequest
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 GetUserGroupsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetUserGroupsRequest | GetUserGroupsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object