Class: QueryFailedFailure
errordetails.v1.QueryFailedFailure
Represents a QueryFailedFailure.
Implements
Constructors
constructor
• new QueryFailedFailure(properties?): QueryFailedFailure
Constructs a new QueryFailedFailure.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IQueryFailedFailure | Properties to set |
Returns
Properties
failure
• Optional failure: null | IFailure
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.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this QueryFailedFailure to JSON.
Returns
Object
JSON object
create
▸ create(properties?): QueryFailedFailure
Creates a new QueryFailedFailure instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IQueryFailedFailure | Properties to set |
Returns
QueryFailedFailure instance
decode
▸ decode(reader, length?): QueryFailedFailure
Decodes a QueryFailedFailure message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
QueryFailedFailure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): QueryFailedFailure
Decodes a QueryFailedFailure message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IQueryFailedFailure | QueryFailedFailure message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IQueryFailedFailure | QueryFailedFailure message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
QueryFailedFailure
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for QueryFailedFailure
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a QueryFailedFailure message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | QueryFailedFailure | QueryFailedFailure |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object