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