Class: UpdateWorkerConfigRequest
workflowservice.v1.UpdateWorkerConfigRequest
Represents an UpdateWorkerConfigRequest.
Properties
identity
• identity: string
The identity of the client who initiated this request.
namespace
• namespace: string
Namespace this worker belongs to.
reason
• reason: string
Reason for sending worker command, can be used for audit purpose.
resourceId
• resourceId: string
Resource ID for routing. Contains the worker grouping key.
selector
• Optional selector: null | $Properties
Defines which workers should receive this command.
updateMask
• Optional updateMask: null | $Properties
Controls which fields from worker_config will be applied
workerConfig
• Optional workerConfig: null | $Properties
Partial updates are accepted and controlled by update_mask. The worker configuration to set.
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkerConfigRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkerConfigRequest & $Shape
Creates a new UpdateWorkerConfigRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
UpdateWorkerConfigRequest & $Shape
UpdateWorkerConfigRequest instance
▸ create(properties?): UpdateWorkerConfigRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): UpdateWorkerConfigRequest & $Shape
Decodes an UpdateWorkerConfigRequest 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
UpdateWorkerConfigRequest & $Shape
UpdateWorkerConfigRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkerConfigRequest & $Shape
Decodes an UpdateWorkerConfigRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkerConfigRequest & $Shape
UpdateWorkerConfigRequest
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 UpdateWorkerConfigRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerConfigRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkerConfigRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkerConfigRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerConfigRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkerConfigRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkerConfigRequest
Creates an UpdateWorkerConfigRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkerConfigRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateWorkerConfigRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkerConfigRequest | UpdateWorkerConfigRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object