Class: GetUsersRequest

cloudservice.v1.GetUsersRequest

Represents a GetUsersRequest.

Implements

• IGetUsersRequest

Constructors

constructor

• new GetUsersRequest(properties?): GetUsersRequest

Constructs a new GetUsersRequest.

Parameters

Name	Type	Description
properties?	IGetUsersRequest	Properties to set

Returns

GetUsersRequest

Properties

email

• email: string

Filter users by email address - optional.

Implementation of

IGetUsersRequest.email

---

namespace

• namespace: string

Filter users by the namespace they have access to - optional.

Implementation of

IGetUsersRequest.namespace

---

pageSize

• pageSize: number

The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.

Implementation of

IGetUsersRequest.pageSize

---

pageToken

• pageToken: string

The page token if this is continuing from another response - optional.

Implementation of

IGetUsersRequest.pageToken

Methods

toJSON

▸ toJSON(): Object

Converts this GetUsersRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): GetUsersRequest

Creates a new GetUsersRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IGetUsersRequest	Properties to set

Returns

GetUsersRequest

GetUsersRequest instance

---

decode

▸ decode(reader, length?): GetUsersRequest

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

GetUsersRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): GetUsersRequest

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

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	IGetUsersRequest	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	IGetUsersRequest	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

GetUsersRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetUsersRequest

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 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