Class: ServiceAccount

identity.v1.ServiceAccount

Represents a ServiceAccount.

Implements

• IServiceAccount

Constructors

constructor

• new ServiceAccount(properties?): ServiceAccount

Constructs a new ServiceAccount.

Parameters

Name	Type	Description
properties?	IServiceAccount	Properties to set

Returns

ServiceAccount

Properties

asyncOperationId

• asyncOperationId: string

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

Implementation of

IServiceAccount.asyncOperationId

---

createdTime

• Optional createdTime: null | ITimestamp

The date and time when the service account was created.

Implementation of

IServiceAccount.createdTime

---

id

• id: string

The id of the service account.

Implementation of

IServiceAccount.id

---

lastModifiedTime

• Optional lastModifiedTime: null | ITimestamp

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

Implementation of

IServiceAccount.lastModifiedTime

---

resourceVersion

• resourceVersion: string

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

Implementation of

IServiceAccount.resourceVersion

---

spec

• Optional spec: null | IServiceAccountSpec

The service account specification.

Implementation of

IServiceAccount.spec

---

state

• state: 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.

Implementation of

IServiceAccount.state

Methods

toJSON

▸ toJSON(): Object

Converts this ServiceAccount to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ServiceAccount

Creates a new ServiceAccount instance using the specified properties.

Parameters

Name	Type	Description
properties?	IServiceAccount	Properties to set

Returns

ServiceAccount

ServiceAccount instance

---

decode

▸ decode(reader, length?): ServiceAccount

Decodes a ServiceAccount 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

ServiceAccount

ServiceAccount

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ServiceAccount

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

ServiceAccount

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

Name	Type	Description
message	IServiceAccount	ServiceAccount message or plain object to encode
writer?	Writer	Writer 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

Name	Type	Description
message	IServiceAccount	ServiceAccount message or plain object to encode
writer?	Writer	Writer 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

Name	Type	Description
object	Object	Plain object

Returns

ServiceAccount

ServiceAccount

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ServiceAccount

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 ServiceAccount message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	ServiceAccount	ServiceAccount
options?	IConversionOptions	Conversion options

Returns

Object

Plain object