Skip to main content

Class: ApplicationFailureInfo

failure.v1.ApplicationFailureInfo

Represents an ApplicationFailureInfo.

Implements

Constructors

constructor

new ApplicationFailureInfo(properties?): ApplicationFailureInfo

Constructs a new ApplicationFailureInfo.

Parameters

NameTypeDescription
properties?IApplicationFailureInfoProperties to set

Returns

ApplicationFailureInfo

Properties

details

Optional details: null | IPayloads

ApplicationFailureInfo details.

Implementation of

IApplicationFailureInfo.details


nextRetryDelay

Optional nextRetryDelay: null | IDuration

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. ATTENTION: this value will be ignored if set for failures produced by the workflow.

Implementation of

IApplicationFailureInfo.nextRetryDelay


nonRetryable

nonRetryable: boolean

ApplicationFailureInfo nonRetryable.

Implementation of

IApplicationFailureInfo.nonRetryable


type

type: string

ApplicationFailureInfo type.

Implementation of

IApplicationFailureInfo.type

Methods

toJSON

toJSON(): Object

Converts this ApplicationFailureInfo to JSON.

Returns

Object

JSON object


create

create(properties?): ApplicationFailureInfo

Creates a new ApplicationFailureInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IApplicationFailureInfoProperties to set

Returns

ApplicationFailureInfo

ApplicationFailureInfo instance


decode

decode(reader, length?): ApplicationFailureInfo

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

ApplicationFailureInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ApplicationFailureInfo

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ApplicationFailureInfo

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
messageIApplicationFailureInfoApplicationFailureInfo 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
messageIApplicationFailureInfoApplicationFailureInfo 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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ApplicationFailureInfo

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 an ApplicationFailureInfo message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageApplicationFailureInfoApplicationFailureInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object