Class: NamespaceUnavailableFailure
errordetails.v1.NamespaceUnavailableFailure
NamespaceUnavailableFailure is returned by the service when a request addresses a namespace that is unavailable. For example, when a namespace is in the process of failing over between clusters. This is a transient error that should be automatically retried by clients.
Implements
Constructors
constructor
• new NamespaceUnavailableFailure(properties?): NamespaceUnavailableFailure
Constructs a new NamespaceUnavailableFailure.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceUnavailableFailure | Properties to set |
Returns
Properties
namespace
• namespace: string
NamespaceUnavailableFailure namespace.
Implementation of
INamespaceUnavailableFailure.namespace
Methods
toJSON
▸ toJSON(): Object
Converts this NamespaceUnavailableFailure to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NamespaceUnavailableFailure
Creates a new NamespaceUnavailableFailure instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceUnavailableFailure | Properties to set |
Returns
NamespaceUnavailableFailure instance
decode
▸ decode(reader, length?): NamespaceUnavailableFailure
Decodes a NamespaceUnavailableFailure 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
NamespaceUnavailableFailure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespaceUnavailableFailure
Decodes a NamespaceUnavailableFailure message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NamespaceUnavailableFailure
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 NamespaceUnavailableFailure message. Does not implicitly temporal.api.errordetails.v1.NamespaceUnavailableFailure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceUnavailableFailure | NamespaceUnavailableFailure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NamespaceUnavailableFailure message, length delimited. Does not implicitly temporal.api.errordetails.v1.NamespaceUnavailableFailure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceUnavailableFailure | NamespaceUnavailableFailure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NamespaceUnavailableFailure
Creates a NamespaceUnavailableFailure message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NamespaceUnavailableFailure
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NamespaceUnavailableFailure
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 NamespaceUnavailableFailure message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NamespaceUnavailableFailure | NamespaceUnavailableFailure |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object