Class: MeteringMetadata
Metadata relevant for metering purposes
Implements
Constructors
constructor
• new MeteringMetadata(properties?): MeteringMetadata
Constructs a new MeteringMetadata.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMeteringMetadata | Properties to set |
Returns
Properties
nonfirstLocalActivityExecutionAttempts
• nonfirstLocalActivityExecutionAttempts: number
Count of local activities which have begun an execution attempt during this workflow task, and whose first attempt occurred in some previous task. This is used for metering purposes, and does not affect workflow state.
(-- api-linter: core::0141::forbidden-types=disabled aip.dev/not-precedent: Negative values make no sense to represent. --)
Implementation of
IMeteringMetadata.nonfirstLocalActivityExecutionAttempts
Methods
toJSON
▸ toJSON(): Object
Converts this MeteringMetadata to JSON.
Returns
Object
JSON object
create
▸ create(properties?): MeteringMetadata
Creates a new MeteringMetadata instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMeteringMetadata | Properties to set |
Returns
MeteringMetadata instance
decode
▸ decode(reader, length?): MeteringMetadata
Decodes a MeteringMetadata 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
MeteringMetadata
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): MeteringMetadata
Decodes a MeteringMetadata message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
MeteringMetadata
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 MeteringMetadata message. Does not implicitly temporal.api.common.v1.MeteringMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMeteringMetadata | MeteringMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified MeteringMetadata message, length delimited. Does not implicitly temporal.api.common.v1.MeteringMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMeteringMetadata | MeteringMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): MeteringMetadata
Creates a MeteringMetadata message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
MeteringMetadata
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for MeteringMetadata
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 MeteringMetadata message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | MeteringMetadata | MeteringMetadata |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object