Skip to main content

Class: ServiceAccount

identity.v1.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: null | $Properties

The date and time when the service account was created.


id

id: string

The id of the service account.


lastModifiedTime

Optional lastModifiedTime: null | $Properties

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: null | $Properties

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

create(properties?): ServiceAccount & $Properties

Creates a new ServiceAccount instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

ServiceAccount & $Properties

ServiceAccount instance

create(properties?): ServiceAccount

Parameters

NameType
properties?$Properties

Returns

ServiceAccount


decode

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

Decodes a ServiceAccount message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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

decodeDelimited(reader): ServiceAccount & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader 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

encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ServiceAccount

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ServiceAccount

ServiceAccount


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageServiceAccountServiceAccount
options?IConversionOptionsConversion options

Returns

Object

Plain object