Skip to main content

Class: GetUsersResponse

cloudservice.v1.GetUsersResponse

Represents a GetUsersResponse.

Properties​

nextPageToken​

• nextPageToken: string

The next page's token


users​

• users: $Properties[]

The list of users in ascending ids order

Methods​

toJSON​

▸ toJSON(): Object

Converts this GetUsersResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): GetUsersResponse & $Properties

Creates a new GetUsersResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

GetUsersResponse & $Properties

GetUsersResponse instance

▸ create(properties?): GetUsersResponse

Parameters​

NameType
properties?$Properties

Returns​

GetUsersResponse


decode​

▸ decode(reader, length?): GetUsersResponse & $Properties

Decodes a GetUsersResponse message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

GetUsersResponse & $Properties

GetUsersResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): GetUsersResponse & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

GetUsersResponse & $Properties

GetUsersResponse

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 GetUsersResponse message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetUsersResponse.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesGetUsersResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesGetUsersResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): GetUsersResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

GetUsersResponse

GetUsersResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageGetUsersResponseGetUsersResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object