Skip to main content

Class: CanceledFailureInfo

failure.v1.CanceledFailureInfo

Represents a CanceledFailureInfo.

Implements#

Constructors#

constructor#

new CanceledFailureInfo(properties?)

Constructs a new CanceledFailureInfo.

Parameters#

NameType
properties?ICanceledFailureInfo

Properties#

details#

Optional details: null | IPayloads

CanceledFailureInfo details.

Implementation of#

ICanceledFailureInfo.details

Methods#

toJSON#

toJSON(): Object

Converts this CanceledFailureInfo to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CanceledFailureInfo

Decodes a CanceledFailureInfo message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

CanceledFailureInfo

CanceledFailureInfo


decodeDelimited#

Static decodeDelimited(reader): CanceledFailureInfo

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

CanceledFailureInfo

CanceledFailureInfo


encode#

Static encode(message, writer?): Writer

Encodes the specified CanceledFailureInfo message. Does not implicitly {@link temporal.api.failure.v1.CanceledFailureInfo.verify|verify} messages.

Parameters#

NameTypeDescription
messageICanceledFailureInfoCanceledFailureInfo message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified CanceledFailureInfo message, length delimited. Does not implicitly {@link temporal.api.failure.v1.CanceledFailureInfo.verify|verify} messages.

Parameters#

NameTypeDescription
messageICanceledFailureInfoCanceledFailureInfo message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): CanceledFailureInfo

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

CanceledFailureInfo

CanceledFailureInfo


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCanceledFailureInfoCanceledFailureInfo
options?IConversionOptions-

Returns#

Object

Plain object