Skip to main content

Class: QueryFailedFailure

errordetails.v1.QueryFailedFailure

Represents a QueryFailedFailure.

Properties

failure

Optional failure: null | $Properties

The full reason for this query failure. May not be available if the response is generated by an old SDK. This field can be encoded by the SDK's failure converter to support E2E encryption of messages and stack traces.

Methods

toJSON

toJSON(): Object

Converts this QueryFailedFailure to JSON.

Returns

Object

JSON object


create

create(properties?): QueryFailedFailure & $Shape

Creates a new QueryFailedFailure instance using the specified properties.

Parameters

NameTypeDescription
properties?$ShapeProperties to set

Returns

QueryFailedFailure & $Shape

QueryFailedFailure instance

create(properties?): QueryFailedFailure

Parameters

NameType
properties?$Properties

Returns

QueryFailedFailure


decode

decode(reader, length?): QueryFailedFailure & $Shape

Decodes a QueryFailedFailure message from the specified reader or buffer.

Parameters

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

Returns

QueryFailedFailure & $Shape

QueryFailedFailure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): QueryFailedFailure & $Shape

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

QueryFailedFailure & $Shape

QueryFailedFailure

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): QueryFailedFailure

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

QueryFailedFailure

QueryFailedFailure


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageQueryFailedFailureQueryFailedFailure
options?IConversionOptionsConversion options

Returns

Object

Plain object