Skip to main content

Class: RetryPolicy

common.v1.RetryPolicy

Represents a RetryPolicy.

Implements

Constructors

constructor

new RetryPolicy(properties?)

Constructs a new RetryPolicy.

Parameters

NameTypeDescription
properties?IRetryPolicyProperties to set

Properties

backoffCoefficient

backoffCoefficient: number

RetryPolicy backoffCoefficient.

Implementation of

IRetryPolicy.backoffCoefficient


initialInterval

Optional initialInterval: null | IDuration

RetryPolicy initialInterval.

Implementation of

IRetryPolicy.initialInterval


maximumAttempts

maximumAttempts: number

RetryPolicy maximumAttempts.

Implementation of

IRetryPolicy.maximumAttempts


maximumInterval

Optional maximumInterval: null | IDuration

RetryPolicy maximumInterval.

Implementation of

IRetryPolicy.maximumInterval


nonRetryableErrorTypes

nonRetryableErrorTypes: string[]

RetryPolicy nonRetryableErrorTypes.

Implementation of

IRetryPolicy.nonRetryableErrorTypes

Methods

toJSON

toJSON(): Object

Converts this RetryPolicy to JSON.

Returns

Object

JSON object


create

Static create(properties?): RetryPolicy

Creates a new RetryPolicy instance using the specified properties.

Parameters

NameTypeDescription
properties?IRetryPolicyProperties to set

Returns

RetryPolicy

RetryPolicy instance


decode

Static decode(reader, length?): RetryPolicy

Decodes a RetryPolicy message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

RetryPolicy

RetryPolicy


decodeDelimited

Static decodeDelimited(reader): RetryPolicy

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RetryPolicy

RetryPolicy


encode

Static encode(message, writer?): Writer

Encodes the specified RetryPolicy message. Does not implicitly temporal.api.common.v1.RetryPolicy.verify|verify messages.

Parameters

NameTypeDescription
messageIRetryPolicyRetryPolicy message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIRetryPolicyRetryPolicy message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static fromObject(object): RetryPolicy

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RetryPolicy

RetryPolicy


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RetryPolicy

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRetryPolicyRetryPolicy
options?IConversionOptionsConversion options

Returns

Object

Plain object