temporalio.client.BuildIdOpAddNewCompatible

class documentation

class BuildIdOpAddNewCompatible(BuildIdOp): (source)

Adds a new Build Id into an existing compatible set. The newly added ID becomes the default for that compatible set, and thus new workflow tasks for workflows which have been executing on workers in that set will now start on this new Build Id.

Class Variable	`build_id`	The Build Id to add to the compatible set.
Class Variable	`existing_compatible_build_id`	A Build Id which must already be defined on the task queue, and is used to find the compatible set to add the new id to.
Class Variable	`promote_set`	If set to true, the targeted set will also be promoted to become the overall default set for the queue.
Method	`_as_partial_proto`	Returns a partial request with the operation populated. Caller must populate non-operation fields. This is done b/c there's no good way to assign a non-primitive message as the operation after initializing the request.

build_id: str = (source) ¶

The Build Id to add to the compatible set.

existing_compatible_build_id: str = (source) ¶

A Build Id which must already be defined on the task queue, and is used to find the compatible set to add the new id to.

promote_set: bool = (source) ¶

If set to true, the targeted set will also be promoted to become the overall default set for the queue.

def _as_partial_proto(self) -> temporalio.api.workflowservice.v1.UpdateWorkerBuildIdCompatibilityRequest: (source) ¶

overrides temporalio.client.BuildIdOp._as_partial_proto

Returns a partial request with the operation populated. Caller must populate non-operation fields. This is done b/c there's no good way to assign a non-primitive message as the operation after initializing the request.