Skip to main content

Class: ServiceAccount

Represents a ServiceAccount.

Properties​

asyncOperationId​

asyncOperationId: string

The id of the async operation that is creating/updating/deleting the service account, if any.


createdTime?​

optional createdTime?: $Properties | null

The date and time when the service account was created.


id​

id: string

The id of the service account.


lastModifiedTime?​

optional lastModifiedTime?: $Properties | null

The date and time when the service account was last modified Will not be set if the service account has never been modified.


resourceVersion​

resourceVersion: string

The current version of the service account specification. The next update operation will have to include this version.


spec?​

optional spec?: $Properties | null

The service account specification.


state​

state: ResourceState

The current state of the service account. For any failed state, reach out to Temporal Cloud support for remediation. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated


stateDeprecated​

stateDeprecated: string

The current state of the service account. Possible values: activating, activationfailed, active, updating, updatefailed, deleting, deletefailed, deleted, suspending, suspendfailed, suspended. For any failed state, reach out to Temporal Cloud support for remediation. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0

Methods​

toJSON()​

toJSON(): object

Converts this ServiceAccount to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): ServiceAccount & $Properties

Creates a new ServiceAccount instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ServiceAccount & $Properties

ServiceAccount instance

Call Signature​

static create(properties?): ServiceAccount

Creates a new ServiceAccount instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ServiceAccount

ServiceAccount instance


decode()​

static decode(reader, length?): ServiceAccount & $Properties

Decodes a ServiceAccount message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ServiceAccount & $Properties

ServiceAccount

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): ServiceAccount & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ServiceAccount & $Properties

ServiceAccount

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


encode()​

static encode(message, writer?): Writer

Encodes the specified ServiceAccount message. Does not implicitly temporal.api.cloud.identity.v1.ServiceAccount.verify|verify messages.

Parameters​

message​

$Properties

ServiceAccount message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ServiceAccount message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): ServiceAccount

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ServiceAccount

ServiceAccount


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ServiceAccount

ServiceAccount

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object