Skip to main content

Class: FailWorkflowExecutionCommandAttributes

command.v1.FailWorkflowExecutionCommandAttributes

Represents a FailWorkflowExecutionCommandAttributes.

Properties​

failure​

• Optional failure: null | $Properties

FailWorkflowExecutionCommandAttributes failure.

Methods​

toJSON​

▸ toJSON(): Object

Converts this FailWorkflowExecutionCommandAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): FailWorkflowExecutionCommandAttributes & $Shape

Creates a new FailWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

FailWorkflowExecutionCommandAttributes & $Shape

FailWorkflowExecutionCommandAttributes instance

▸ create(properties?): FailWorkflowExecutionCommandAttributes

Parameters​

NameType
properties?$Properties

Returns​

FailWorkflowExecutionCommandAttributes


decode​

▸ decode(reader, length?): FailWorkflowExecutionCommandAttributes & $Shape

Decodes a FailWorkflowExecutionCommandAttributes message from the specified reader or buffer.

Parameters​

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

Returns​

FailWorkflowExecutionCommandAttributes & $Shape

FailWorkflowExecutionCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): FailWorkflowExecutionCommandAttributes & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

FailWorkflowExecutionCommandAttributes & $Shape

FailWorkflowExecutionCommandAttributes

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): FailWorkflowExecutionCommandAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

FailWorkflowExecutionCommandAttributes

FailWorkflowExecutionCommandAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageFailWorkflowExecutionCommandAttributesFailWorkflowExecutionCommandAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object