Skip to main content

Class: 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()​

Call Signature​

static create(properties?): GetUsersRequest & $Properties

Creates a new GetUsersRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetUsersRequest & $Properties

GetUsersRequest instance

Call Signature​

static create(properties?): GetUsersRequest

Creates a new GetUsersRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetUsersRequest

GetUsersRequest instance


decode()​

static decode(reader, length?): GetUsersRequest & $Properties

Decodes a GetUsersRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

GetUsersRequest & $Properties

GetUsersRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): GetUsersRequest & $Properties

Decodes a GetUsersRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetUsersRequest & $Properties

GetUsersRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


encode()​

static encode(message, writer?): Writer

Encodes the specified GetUsersRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUsersRequest.verify|verify messages.

Parameters​

message​

$Properties

GetUsersRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified GetUsersRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUsersRequest.verify|verify messages.

Parameters​

message​

$Properties

GetUsersRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): GetUsersRequest

Creates a GetUsersRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GetUsersRequest

GetUsersRequest


toObject()​

static toObject(message, options?): object

Creates a plain object from a GetUsersRequest message. Also converts values to other types if specified.

Parameters​

message​

GetUsersRequest

GetUsersRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object