Skip to main content

Class: ConfigMetadata

taskqueue.v1.ConfigMetadata

Represents a ConfigMetadata.

Implements

Constructors

constructor

new ConfigMetadata(properties?): ConfigMetadata

Constructs a new ConfigMetadata.

Parameters

NameTypeDescription
properties?IConfigMetadataProperties to set

Returns

ConfigMetadata

Properties

reason

reason: string

Reason for why the config was set.

Implementation of

IConfigMetadata.reason


updateIdentity

updateIdentity: string

Identity of the last updater. Set by the request's identity field.

Implementation of

IConfigMetadata.updateIdentity


updateTime

Optional updateTime: null | ITimestamp

Time of the last update.

Implementation of

IConfigMetadata.updateTime

Methods

toJSON

toJSON(): Object

Converts this ConfigMetadata to JSON.

Returns

Object

JSON object


create

create(properties?): ConfigMetadata

Creates a new ConfigMetadata instance using the specified properties.

Parameters

NameTypeDescription
properties?IConfigMetadataProperties to set

Returns

ConfigMetadata

ConfigMetadata instance


decode

decode(reader, length?): ConfigMetadata

Decodes a ConfigMetadata message from the specified reader or buffer.

Parameters

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

Returns

ConfigMetadata

ConfigMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ConfigMetadata

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ConfigMetadata

ConfigMetadata

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 ConfigMetadata message. Does not implicitly temporal.api.taskqueue.v1.ConfigMetadata.verify|verify messages.

Parameters

NameTypeDescription
messageIConfigMetadataConfigMetadata message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified ConfigMetadata message, length delimited. Does not implicitly temporal.api.taskqueue.v1.ConfigMetadata.verify|verify messages.

Parameters

NameTypeDescription
messageIConfigMetadataConfigMetadata message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ConfigMetadata

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ConfigMetadata

ConfigMetadata


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ConfigMetadata

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageConfigMetadataConfigMetadata
options?IConversionOptionsConversion options

Returns

Object

Plain object