Skip to main content

Class: GetUserRequest

cloudservice.v1.GetUserRequest

Represents a GetUserRequest.

Implements

Constructors

constructor

new GetUserRequest(properties?): GetUserRequest

Constructs a new GetUserRequest.

Parameters

NameTypeDescription
properties?IGetUserRequestProperties to set

Returns

GetUserRequest

Properties

userId

userId: string

The id of the user to get

Implementation of

IGetUserRequest.userId

Methods

toJSON

toJSON(): Object

Converts this GetUserRequest to JSON.

Returns

Object

JSON object


create

create(properties?): GetUserRequest

Creates a new GetUserRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IGetUserRequestProperties to set

Returns

GetUserRequest

GetUserRequest instance


decode

decode(reader, length?): GetUserRequest

Decodes a GetUserRequest message from the specified reader or buffer.

Parameters

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

Returns

GetUserRequest

GetUserRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): GetUserRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetUserRequest

GetUserRequest

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

Parameters

NameTypeDescription
messageIGetUserRequestGetUserRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIGetUserRequestGetUserRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): GetUserRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

GetUserRequest

GetUserRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetUserRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageGetUserRequestGetUserRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object