Class: GetCurrentIdentityResponse
cloudservice.v1.GetCurrentIdentityResponse
Represents a GetCurrentIdentityResponse.
Implements
Constructors
constructor
• new GetCurrentIdentityResponse(properties?): GetCurrentIdentityResponse
Constructs a new GetCurrentIdentityResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetCurrentIdentityResponse | Properties to set |
Returns
Properties
principal
• Optional principal: "user" | "serviceAccount"
The authenticated principal making the request
principalApiKey
• Optional principalApiKey: null | IApiKey
The API key info used to authenticate the request, if any
Implementation of
IGetCurrentIdentityResponse.principalApiKey
serviceAccount
• Optional serviceAccount: null | IServiceAccount
The user is a service account
Implementation of
IGetCurrentIdentityResponse.serviceAccount
user
• Optional user: null | IUser
The user is a regular user
Implementation of
IGetCurrentIdentityResponse.user
Methods
toJSON
▸ toJSON(): Object
Converts this GetCurrentIdentityResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetCurrentIdentityResponse
Creates a new GetCurrentIdentityResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetCurrentIdentityResponse | Properties to set |
Returns
GetCurrentIdentityResponse instance
decode
▸ decode(reader, length?): GetCurrentIdentityResponse
Decodes a GetCurrentIdentityResponse 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
GetCurrentIdentityResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetCurrentIdentityResponse
Decodes a GetCurrentIdentityResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IGetCurrentIdentityResponse | GetCurrentIdentityResponse message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IGetCurrentIdentityResponse | GetCurrentIdentityResponse message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetCurrentIdentityResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetCurrentIdentityResponse
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 GetCurrentIdentityResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetCurrentIdentityResponse | GetCurrentIdentityResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object