Skip to main content

Class: ProtocolMessageCommandAttributes

command.v1.ProtocolMessageCommandAttributes

Represents a ProtocolMessageCommandAttributes.

Properties

messageId

messageId: string

The message ID of the message to which this command is a pointer.

Methods

toJSON

toJSON(): Object

Converts this ProtocolMessageCommandAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): ProtocolMessageCommandAttributes & $Properties

Creates a new ProtocolMessageCommandAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

ProtocolMessageCommandAttributes & $Properties

ProtocolMessageCommandAttributes instance

create(properties?): ProtocolMessageCommandAttributes

Parameters

NameType
properties?$Properties

Returns

ProtocolMessageCommandAttributes


decode

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

Decodes a ProtocolMessageCommandAttributes message from the specified reader or buffer.

Parameters

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

Returns

ProtocolMessageCommandAttributes & $Properties

ProtocolMessageCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ProtocolMessageCommandAttributes & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ProtocolMessageCommandAttributes & $Properties

ProtocolMessageCommandAttributes

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ProtocolMessageCommandAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ProtocolMessageCommandAttributes

ProtocolMessageCommandAttributes


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageProtocolMessageCommandAttributesProtocolMessageCommandAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object