Class: Account
Represents an Account.
Implements
Constructors
constructor
• new Account(properties?
): Account
Constructs a new Account.
Parameters
Name | Type | Description |
---|---|---|
properties? | IAccount | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id of the async operation that is updating the account, if any.
Implementation of
id
• id: string
The id of the account.
Implementation of
metrics
• Optional
metrics: null
| IMetrics
Information related to metrics.
Implementation of
resourceVersion
• resourceVersion: string
The current version of the account specification. The next update operation will have to include this version.
Implementation of
spec
• Optional
spec: null
| IAccountSpec
The account specification.
Implementation of
state
• state: ResourceState
The current state of the account.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Account to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): Account
Creates a new Account instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IAccount | Properties to set |
Returns
Account instance
decode
▸ decode(reader
, length?
): Account
Decodes an Account 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
Account
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): Account
Decodes an Account message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
Name | Type | Description |
---|---|---|
message | IAccount | Account message or plain object to encode |
writer? | Writer | Writer 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
Name | Type | Description |
---|---|---|
message | IAccount | Account message or plain object to encode |
writer? | Writer | Writer 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
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
Account
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for Account
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 an Account message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | Account | Account |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object