Skip to main content

Class: TimeoutFailureInfo

failure.v1.TimeoutFailureInfo

Represents a TimeoutFailureInfo.

Properties

lastHeartbeatDetails

Optional lastHeartbeatDetails: null | $Properties

TimeoutFailureInfo lastHeartbeatDetails.


timeoutType

timeoutType: TimeoutType

TimeoutFailureInfo timeoutType.

Methods

toJSON

toJSON(): Object

Converts this TimeoutFailureInfo to JSON.

Returns

Object

JSON object


create

create(properties?): TimeoutFailureInfo & $Properties

Creates a new TimeoutFailureInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

TimeoutFailureInfo & $Properties

TimeoutFailureInfo instance

create(properties?): TimeoutFailureInfo

Parameters

NameType
properties?$Properties

Returns

TimeoutFailureInfo


decode

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

Decodes a TimeoutFailureInfo message from the specified reader or buffer.

Parameters

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

Returns

TimeoutFailureInfo & $Properties

TimeoutFailureInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): TimeoutFailureInfo & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

TimeoutFailureInfo & $Properties

TimeoutFailureInfo

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

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


toObject

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