Class: CodecServerSpec
Represents a CodecServerSpec.
Properties
customErrorMessage
• Optional customErrorMessage: null | $Properties
A custom error message to display for remote codec server errors. temporal:versioning:min_version=v0.5.1
endpoint
• endpoint: string
The codec server endpoint.
includeCrossOriginCredentials
• includeCrossOriginCredentials: boolean
Whether to include cross-origin credentials.
passAccessToken
• passAccessToken: boolean
Whether to pass the user access token with your endpoint.
Methods
toJSON
▸ toJSON(): Object
Converts this CodecServerSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CodecServerSpec & $Properties
Creates a new CodecServerSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CodecServerSpec instance
▸ create(properties?): CodecServerSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CodecServerSpec & $Properties
Decodes a CodecServerSpec 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
CodecServerSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CodecServerSpec & $Properties
Decodes a CodecServerSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CodecServerSpec
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 CodecServerSpec message. Does not implicitly temporal.api.cloud.namespace.v1.CodecServerSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CodecServerSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CodecServerSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.CodecServerSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CodecServerSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CodecServerSpec
Creates a CodecServerSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CodecServerSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CodecServerSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CodecServerSpec | CodecServerSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object