Class: GetUsersRequest
cloudservice.v1.GetUsersRequest
Represents a GetUsersRequest.
Properties
email
• email: string
Filter users by email address - optional.
namespace
• namespace: string
Filter users 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.
Methods
toJSON
▸ toJSON(): Object
Converts this GetUsersRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetUsersRequest & $Properties
Creates a new GetUsersRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
GetUsersRequest instance
▸ create(properties?): GetUsersRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): GetUsersRequest & $Properties
Decodes a GetUsersRequest 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
GetUsersRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetUsersRequest & $Properties
Decodes a GetUsersRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetUsersRequest
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 GetUsersRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUsersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetUsersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetUsersRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUsersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetUsersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetUsersRequest
Creates a GetUsersRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetUsersRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a GetUsersRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetUsersRequest | GetUsersRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object