Package io.temporal.client

Class BuildIdOperation

java.lang.Object

io.temporal.client.BuildIdOperation

public abstract class BuildIdOperation
extends java.lang.Object

The implementations of this class can be passed as parameters to WorkflowClient.updateWorkerBuildIdCompatability(String, BuildIdOperation)

See each public static method to learn about and construct the available operations.

Method Summary

Modifier and Type	Method	Description
static BuildIdOperation	mergeSets(java.lang.String primaryBuildId, java.lang.String secondaryBuildId)	This operation merges two sets into one set, thus declaring all the Build Ids in both as compatible with one another.
static BuildIdOperation	newCompatibleVersion(java.lang.String buildId, java.lang.String existingCompatibleBuildId)	Performs newCompatibleVersion(String, String, boolean), with `makeSetDefault` set to false.
static BuildIdOperation	newCompatibleVersion(java.lang.String buildId, java.lang.String existingCompatibleBuildId, boolean makeSetDefault)	This operation adds a new Build Id into an existing compatible set.
static BuildIdOperation	newIdInNewDefaultSet(java.lang.String buildId)	This operation adds a new Build Id into a new set, which will be used as the default set for the queue.
static BuildIdOperation	promoteBuildIdWithinSet(java.lang.String buildId)	This operation promotes a Build Id inside some compatible set to become the default ID in that set.
static BuildIdOperation	promoteSetByBuildId(java.lang.String buildId)	This operation promotes a set to become the overall default set for the queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newIdInNewDefaultSet

public static BuildIdOperation newIdInNewDefaultSet(@Nonnull
                                                    java.lang.String buildId)

This operation adds a new Build Id into a new set, which will be used as the default set for the queue. This means all new workflows will start on this Build Id.

Parameters:

buildId - The Build Id to add as the new overall default.

newCompatibleVersion

public static BuildIdOperation newCompatibleVersion(@Nonnull
                                                    java.lang.String buildId,
                                                    @Nonnull
                                                    java.lang.String existingCompatibleBuildId,
                                                    boolean makeSetDefault)

This operation 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.

Parameters:

buildId - The Build Id to add to an existing compatible set.

existingCompatibleBuildId - 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.

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

newCompatibleVersion

public static BuildIdOperation newCompatibleVersion(@Nonnull
                                                    java.lang.String buildId,
                                                    @Nonnull
                                                    java.lang.String existingCompatibleBuildId)

Performs newCompatibleVersion(String, String, boolean), with `makeSetDefault` set to false.

promoteSetByBuildId

public static BuildIdOperation promoteSetByBuildId(@Nonnull
                                                   java.lang.String buildId)

This operation promotes a set to become the overall default set for the queue.

Parameters:

buildId - An existing Build Id which is used to find the set to be promoted.

promoteBuildIdWithinSet

public static BuildIdOperation promoteBuildIdWithinSet(@Nonnull
                                                       java.lang.String buildId)

This operation promotes a Build Id inside some compatible set to become the default ID in that set.

Parameters:

buildId - An existing Build Id which will be promoted within its compatible set.

mergeSets

public static BuildIdOperation mergeSets(@Nonnull
                                         java.lang.String primaryBuildId,
                                         @Nonnull
                                         java.lang.String secondaryBuildId)

This operation merges two sets into one set, thus declaring all the Build Ids in both as compatible with one another. The default of the primary set is maintained as the merged set's overall default.

Parameters:

primaryBuildId - A Build Id which is used to find the primary set to be merged.

secondaryBuildId - A Build Id which is used to find the secondary set to be merged.