Skip to main content

Class: TimeoutFailureInfo

failure.v1.TimeoutFailureInfo

Represents a TimeoutFailureInfo.

Implements

Constructors

constructor

new TimeoutFailureInfo(properties?)

Constructs a new TimeoutFailureInfo.

Parameters

NameTypeDescription
properties?ITimeoutFailureInfoProperties to set

Properties

lastHeartbeatDetails

Optional lastHeartbeatDetails: null | IPayloads

TimeoutFailureInfo lastHeartbeatDetails.

Implementation of

ITimeoutFailureInfo.lastHeartbeatDetails


timeoutType

timeoutType: TimeoutType

TimeoutFailureInfo timeoutType.

Implementation of

ITimeoutFailureInfo.timeoutType

Methods

toJSON

toJSON(): Object

Converts this TimeoutFailureInfo to JSON.

Returns

Object

JSON object


create

Static create(properties?): TimeoutFailureInfo

Creates a new TimeoutFailureInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?ITimeoutFailureInfoProperties to set

Returns

TimeoutFailureInfo

TimeoutFailureInfo instance


decode

Static decode(reader, length?): TimeoutFailureInfo

Decodes a TimeoutFailureInfo 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

TimeoutFailureInfo

TimeoutFailureInfo


decodeDelimited

Static decodeDelimited(reader): TimeoutFailureInfo

Decodes a TimeoutFailureInfo 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

TimeoutFailureInfo

TimeoutFailureInfo


encode

Static encode(message, writer?): Writer

Encodes the specified TimeoutFailureInfo message. Does not implicitly temporal.api.failure.v1.TimeoutFailureInfo.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): TimeoutFailureInfo

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

TimeoutFailureInfo

TimeoutFailureInfo


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TimeoutFailureInfo

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

Parameters

NameTypeDescription
messageTimeoutFailureInfoTimeoutFailureInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object