Skip to main content

Class: Account

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

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

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

create(properties?): Account & $Properties

Creates a new Account instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

Account & $Properties

Account instance

create(properties?): Account

Parameters

NameType
properties?$Properties

Returns

Account


decode

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

Decodes an Account message from the specified reader or buffer.

Parameters

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

decodeDelimited(reader): Account & $Properties

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

Parameters

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

encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Account

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Account

Account


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageAccountAccount
options?IConversionOptionsConversion options

Returns

Object

Plain object