Class: GetWorkerBuildIdCompatibilityRequest
workflowservice.v1.GetWorkerBuildIdCompatibilityRequest
[cleanup-wv-pre-release]
Properties
maxSets
• maxSets: number
Limits how many compatible sets will be returned. Specify 1 to only return the current default major version set. 0 returns all sets.
namespace
• namespace: string
GetWorkerBuildIdCompatibilityRequest namespace.
taskQueue
• taskQueue: string
Must be set, the task queue to interrogate about worker id compatibility.
Methods
toJSON
▸ toJSON(): Object
Converts this GetWorkerBuildIdCompatibilityRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetWorkerBuildIdCompatibilityRequest & $Properties
Creates a new GetWorkerBuildIdCompatibilityRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
GetWorkerBuildIdCompatibilityRequest & $Properties
GetWorkerBuildIdCompatibilityRequest instance
▸ create(properties?): GetWorkerBuildIdCompatibilityRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
GetWorkerBuildIdCompatibilityRequest
decode
▸ decode(reader, length?): GetWorkerBuildIdCompatibilityRequest & $Properties
Decodes a GetWorkerBuildIdCompatibilityRequest 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
GetWorkerBuildIdCompatibilityRequest & $Properties
GetWorkerBuildIdCompatibilityRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetWorkerBuildIdCompatibilityRequest & $Properties
Decodes a GetWorkerBuildIdCompatibilityRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetWorkerBuildIdCompatibilityRequest & $Properties
GetWorkerBuildIdCompatibilityRequest
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 GetWorkerBuildIdCompatibilityRequest message. Does not implicitly temporal.api.workflowservice.v1.GetWorkerBuildIdCompatibilityRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetWorkerBuildIdCompatibilityRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetWorkerBuildIdCompatibilityRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetWorkerBuildIdCompatibilityRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetWorkerBuildIdCompatibilityRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetWorkerBuildIdCompatibilityRequest
Creates a GetWorkerBuildIdCompatibilityRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetWorkerBuildIdCompatibilityRequest
GetWorkerBuildIdCompatibilityRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a GetWorkerBuildIdCompatibilityRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetWorkerBuildIdCompatibilityRequest | GetWorkerBuildIdCompatibilityRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object