Skip to main content

Class: Account

Represents an Account.

Properties​

asyncOperationId​

asyncOperationId: string

The id of the async operation that is updating the account, if any.

id​

id: string

The id of the account.

metrics?​

optional metrics?: $Properties | null

Information related to metrics.

resourceVersion​

resourceVersion: string

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

spec?​

optional spec?: $Properties | null

The account specification.

state​

state: ResourceState

The current state of the account.

Methods​

toJSON()​

toJSON(): object

Converts this Account to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Account & $Properties

Creates a new Account instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Account & $Properties

Account instance

Call Signature​

static create(properties?): Account

Creates a new Account instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Account

Account instance

decode()​

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

Decodes an Account 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​

Account & $Properties

Account

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Account & $Properties

Decodes an Account message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Account & $Properties

Account

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

Parameters​

message​

$Properties

Account message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Account message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Account

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Account

Account

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Account

Account

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object