Skip to main content

Class: MeteringMetadata

common.v1.MeteringMetadata

Metadata relevant for metering purposes

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. --)

Methods​

toJSON​

▸ toJSON(): Object

Converts this MeteringMetadata to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): MeteringMetadata & $Properties

Creates a new MeteringMetadata instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

MeteringMetadata & $Properties

MeteringMetadata instance

▸ create(properties?): MeteringMetadata

Parameters​

NameType
properties?$Properties

Returns​

MeteringMetadata


decode​

▸ decode(reader, length?): MeteringMetadata & $Properties

Decodes a MeteringMetadata message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

MeteringMetadata & $Properties

MeteringMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): MeteringMetadata & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

MeteringMetadata & $Properties

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​

NameTypeDescription
message$PropertiesMeteringMetadata message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
message$PropertiesMeteringMetadata message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
objectObjectPlain object

Returns​

MeteringMetadata

MeteringMetadata


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageMeteringMetadataMeteringMetadata
options?IConversionOptionsConversion options

Returns​

Object

Plain object