Package io.temporal.api.workflow.v1

Class VersioningOverride.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, VersioningOverrideOrBuilder, java.lang.Cloneable
    Enclosing class:
    VersioningOverride
    public static final class VersioningOverride.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>
implements VersioningOverrideOrBuilder
     Used to override the versioning behavior (and pinned deployment version, if applicable) of a
 specific workflow execution. If set, takes precedence over the worker-sent values. See
 `WorkflowExecutionInfo.VersioningInfo` for more information. To remove the override, call
 `UpdateWorkflowExecutionOptions` with a null `VersioningOverride`, and use the `update_mask`
 to indicate that it should be mutated.
 Pinned overrides are automatically inherited by child workflows, continue-as-new workflows,
 workflow retries, and cron workflows.
    Protobuf type temporal.api.workflow.v1.VersioningOverride

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • clear

        public VersioningOverride.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • getDefaultInstanceForType

        public VersioningOverride getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public VersioningOverride build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public VersioningOverride buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public VersioningOverride.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • setField

        public VersioningOverride.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • clearField

        public VersioningOverride.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • clearOneof

        public VersioningOverride.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • setRepeatedField

        public VersioningOverride.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • addRepeatedField

        public VersioningOverride.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • mergeFrom

        public VersioningOverride.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VersioningOverride.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • mergeFrom

        public VersioningOverride.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VersioningOverride.Builder>
        Throws:
        java.io.IOException

      • hasPinned

        public boolean hasPinned()
         Send the next workflow task to the Version specified in the override.
        .temporal.api.workflow.v1.VersioningOverride.PinnedOverride pinned = 3;
        Specified by:
        hasPinned in interface VersioningOverrideOrBuilder
        Returns:
        Whether the pinned field is set.

      • clearPinned

        public VersioningOverride.Builder clearPinned()
         Send the next workflow task to the Version specified in the override.
        .temporal.api.workflow.v1.VersioningOverride.PinnedOverride pinned = 3;

      • getPinnedBuilder

        public VersioningOverride.PinnedOverride.Builder getPinnedBuilder()
         Send the next workflow task to the Version specified in the override.
        .temporal.api.workflow.v1.VersioningOverride.PinnedOverride pinned = 3;

      • hasAutoUpgrade

        public boolean hasAutoUpgrade()
         Send the next workflow task to the Current Deployment Version
 of its Task Queue when the next workflow task is dispatched.
        bool auto_upgrade = 4;
        Specified by:
        hasAutoUpgrade in interface VersioningOverrideOrBuilder
        Returns:
        Whether the autoUpgrade field is set.

      • getAutoUpgrade

        public boolean getAutoUpgrade()
         Send the next workflow task to the Current Deployment Version
 of its Task Queue when the next workflow task is dispatched.
        bool auto_upgrade = 4;
        Specified by:
        getAutoUpgrade in interface VersioningOverrideOrBuilder
        Returns:
        The autoUpgrade.

      • setAutoUpgrade

        public VersioningOverride.Builder setAutoUpgrade​(boolean value)
         Send the next workflow task to the Current Deployment Version
 of its Task Queue when the next workflow task is dispatched.
        bool auto_upgrade = 4;
        Parameters:
        value - The autoUpgrade to set.
        Returns:
        This builder for chaining.

      • clearAutoUpgrade

        public VersioningOverride.Builder clearAutoUpgrade()
         Send the next workflow task to the Current Deployment Version
 of its Task Queue when the next workflow task is dispatched.
        bool auto_upgrade = 4;
        Returns:
        This builder for chaining.

      • getBehaviorValue

        @Deprecated
public int getBehaviorValue()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.behavior is deprecated. See temporal/api/workflow/v1/message.proto;l=551
         Required.
 Deprecated. Use `override`.
        .temporal.api.enums.v1.VersioningBehavior behavior = 1 [deprecated = true];
        Specified by:
        getBehaviorValue in interface VersioningOverrideOrBuilder
        Returns:
        The enum numeric value on the wire for behavior.

      • setBehaviorValue

        @Deprecated
public VersioningOverride.Builder setBehaviorValue​(int value)
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.behavior is deprecated. See temporal/api/workflow/v1/message.proto;l=551
         Required.
 Deprecated. Use `override`.
        .temporal.api.enums.v1.VersioningBehavior behavior = 1 [deprecated = true];
        Parameters:
        value - The enum numeric value on the wire for behavior to set.
        Returns:
        This builder for chaining.

      • getBehavior

        @Deprecated
public VersioningBehavior getBehavior()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.behavior is deprecated. See temporal/api/workflow/v1/message.proto;l=551
         Required.
 Deprecated. Use `override`.
        .temporal.api.enums.v1.VersioningBehavior behavior = 1 [deprecated = true];
        Specified by:
        getBehavior in interface VersioningOverrideOrBuilder
        Returns:
        The behavior.

      • setBehavior

        @Deprecated
public VersioningOverride.Builder setBehavior​(VersioningBehavior value)
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.behavior is deprecated. See temporal/api/workflow/v1/message.proto;l=551
         Required.
 Deprecated. Use `override`.
        .temporal.api.enums.v1.VersioningBehavior behavior = 1 [deprecated = true];
        Parameters:
        value - The behavior to set.
        Returns:
        This builder for chaining.

      • clearBehavior

        @Deprecated
public VersioningOverride.Builder clearBehavior()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.behavior is deprecated. See temporal/api/workflow/v1/message.proto;l=551
         Required.
 Deprecated. Use `override`.
        .temporal.api.enums.v1.VersioningBehavior behavior = 1 [deprecated = true];
        Returns:
        This builder for chaining.

      • hasDeployment

        @Deprecated
public boolean hasDeployment()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.deployment is deprecated. See temporal/api/workflow/v1/message.proto;l=556
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];
        Specified by:
        hasDeployment in interface VersioningOverrideOrBuilder
        Returns:
        Whether the deployment field is set.

      • getDeployment

        @Deprecated
public Deployment getDeployment()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.deployment is deprecated. See temporal/api/workflow/v1/message.proto;l=556
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];
        Specified by:
        getDeployment in interface VersioningOverrideOrBuilder
        Returns:
        The deployment.

      • setDeployment

        @Deprecated
public VersioningOverride.Builder setDeployment​(Deployment value)
        Deprecated.
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];

      • setDeployment

        @Deprecated
public VersioningOverride.Builder setDeployment​(Deployment.Builder builderForValue)
        Deprecated.
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];

      • mergeDeployment

        @Deprecated
public VersioningOverride.Builder mergeDeployment​(Deployment value)
        Deprecated.
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];

      • clearDeployment

        @Deprecated
public VersioningOverride.Builder clearDeployment()
        Deprecated.
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];

      • getDeploymentBuilder

        @Deprecated
public Deployment.Builder getDeploymentBuilder()
        Deprecated.
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];

      • getDeploymentOrBuilder

        @Deprecated
public DeploymentOrBuilder getDeploymentOrBuilder()
        Deprecated.
         Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
 Identifies the worker deployment to pin the workflow to.
 Deprecated. Use `override.pinned.version`.
        .temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];
        Specified by:
        getDeploymentOrBuilder in interface VersioningOverrideOrBuilder

      • getPinnedVersion

        @Deprecated
public java.lang.String getPinnedVersion()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.pinned_version is deprecated. See temporal/api/workflow/v1/message.proto;l=562
         Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.
 Identifies the worker deployment version to pin the workflow to, in the format
 "<deployment_name>.<build_id>".
 Deprecated. Use `override.pinned.version`.
        string pinned_version = 9 [deprecated = true];
        Specified by:
        getPinnedVersion in interface VersioningOverrideOrBuilder
        Returns:
        The pinnedVersion.

      • getPinnedVersionBytes

        @Deprecated
public com.google.protobuf.ByteString getPinnedVersionBytes()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.pinned_version is deprecated. See temporal/api/workflow/v1/message.proto;l=562
         Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.
 Identifies the worker deployment version to pin the workflow to, in the format
 "<deployment_name>.<build_id>".
 Deprecated. Use `override.pinned.version`.
        string pinned_version = 9 [deprecated = true];
        Specified by:
        getPinnedVersionBytes in interface VersioningOverrideOrBuilder
        Returns:
        The bytes for pinnedVersion.

      • setPinnedVersion

        @Deprecated
public VersioningOverride.Builder setPinnedVersion​(java.lang.String value)
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.pinned_version is deprecated. See temporal/api/workflow/v1/message.proto;l=562
         Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.
 Identifies the worker deployment version to pin the workflow to, in the format
 "<deployment_name>.<build_id>".
 Deprecated. Use `override.pinned.version`.
        string pinned_version = 9 [deprecated = true];
        Parameters:
        value - The pinnedVersion to set.
        Returns:
        This builder for chaining.

      • clearPinnedVersion

        @Deprecated
public VersioningOverride.Builder clearPinnedVersion()
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.pinned_version is deprecated. See temporal/api/workflow/v1/message.proto;l=562
         Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.
 Identifies the worker deployment version to pin the workflow to, in the format
 "<deployment_name>.<build_id>".
 Deprecated. Use `override.pinned.version`.
        string pinned_version = 9 [deprecated = true];
        Returns:
        This builder for chaining.

      • setPinnedVersionBytes

        @Deprecated
public VersioningOverride.Builder setPinnedVersionBytes​(com.google.protobuf.ByteString value)
        Deprecated.
        temporal.api.workflow.v1.VersioningOverride.pinned_version is deprecated. See temporal/api/workflow/v1/message.proto;l=562
         Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.
 Identifies the worker deployment version to pin the workflow to, in the format
 "<deployment_name>.<build_id>".
 Deprecated. Use `override.pinned.version`.
        string pinned_version = 9 [deprecated = true];
        Parameters:
        value - The bytes for pinnedVersion to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final VersioningOverride.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>

      • mergeUnknownFields

        public final VersioningOverride.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VersioningOverride.Builder>