Skip to main content

Class: ApplicationFailureInfo

failure.v1.ApplicationFailureInfo

Represents an ApplicationFailureInfo.

Properties

category

category: ApplicationErrorCategory

ApplicationFailureInfo category.


details

Optional details: null | $Properties

ApplicationFailureInfo details.


nextRetryDelay

Optional nextRetryDelay: null | $Properties

next_retry_delay can be used by the client to override the activity retry interval calculated by the retry policy. Retry attempts will still be subject to the maximum retries limit and total time limit defined by the policy.


nonRetryable

nonRetryable: boolean

ApplicationFailureInfo nonRetryable.


type

type: string

ApplicationFailureInfo type.

Methods

toJSON

toJSON(): Object

Converts this ApplicationFailureInfo to JSON.

Returns

Object

JSON object


create

create(properties?): ApplicationFailureInfo & $Properties

Creates a new ApplicationFailureInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

ApplicationFailureInfo & $Properties

ApplicationFailureInfo instance

create(properties?): ApplicationFailureInfo

Parameters

NameType
properties?$Properties

Returns

ApplicationFailureInfo


decode

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

Decodes an ApplicationFailureInfo message from the specified reader or buffer.

Parameters

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

Returns

ApplicationFailureInfo & $Properties

ApplicationFailureInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ApplicationFailureInfo & $Properties

Decodes an ApplicationFailureInfo message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ApplicationFailureInfo & $Properties

ApplicationFailureInfo

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ApplicationFailureInfo

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ApplicationFailureInfo

ApplicationFailureInfo


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageApplicationFailureInfoApplicationFailureInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object