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