Class: CustomErrorMessage
v1.CodecServerSpec.CustomErrorMessage
Represents a CustomErrorMessage.
Implements
Constructors
constructor
• new CustomErrorMessage(properties?): CustomErrorMessage
Constructs a new CustomErrorMessage.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICustomErrorMessage | Properties to set |
Returns
Properties
default
• Optional default: null | IErrorMessage
The error message to display by default for any remote codec server errors.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this CustomErrorMessage to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CustomErrorMessage
Creates a new CustomErrorMessage instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICustomErrorMessage | Properties to set |
Returns
CustomErrorMessage instance
decode
▸ decode(reader, length?): CustomErrorMessage
Decodes a CustomErrorMessage 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
CustomErrorMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CustomErrorMessage
Decodes a CustomErrorMessage message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CustomErrorMessage
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 CustomErrorMessage message. Does not implicitly temporal.api.cloud.namespace.v1.CodecServerSpec.CustomErrorMessage.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICustomErrorMessage | CustomErrorMessage message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CustomErrorMessage message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.CodecServerSpec.CustomErrorMessage.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICustomErrorMessage | CustomErrorMessage message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CustomErrorMessage
Creates a CustomErrorMessage message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CustomErrorMessage
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CustomErrorMessage
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 CustomErrorMessage message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CustomErrorMessage | CustomErrorMessage |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object