Skip to main content

Class: GetCurrentIdentityResponse

cloudservice.v1.GetCurrentIdentityResponse

Represents a GetCurrentIdentityResponse.

Properties​

principal​

• Optional principal: "user" | "serviceAccount"

The authenticated principal making the request


principalApiKey​

• Optional principalApiKey: null | $Properties

The API key info used to authenticate the request, if any


serviceAccount​

• Optional serviceAccount: null | $Properties

The user is a service account


user​

• Optional user: null | $Properties

The user is a regular user

Methods​

toJSON​

▸ toJSON(): Object

Converts this GetCurrentIdentityResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): GetCurrentIdentityResponse & $Shape

Creates a new GetCurrentIdentityResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

GetCurrentIdentityResponse & $Shape

GetCurrentIdentityResponse instance

▸ create(properties?): GetCurrentIdentityResponse

Parameters​

NameType
properties?$Properties

Returns​

GetCurrentIdentityResponse


decode​

▸ decode(reader, length?): GetCurrentIdentityResponse & $Shape

Decodes a GetCurrentIdentityResponse message from the specified reader or buffer.

Parameters​

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

Returns​

GetCurrentIdentityResponse & $Shape

GetCurrentIdentityResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): GetCurrentIdentityResponse & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

GetCurrentIdentityResponse & $Shape

GetCurrentIdentityResponse

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): GetCurrentIdentityResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

GetCurrentIdentityResponse

GetCurrentIdentityResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageGetCurrentIdentityResponseGetCurrentIdentityResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object