Package io.temporal.api.workflow.v1

Class VersioningOverride

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, VersioningOverrideOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:VersioningOverride.java.pb.meta")
public final class VersioningOverride
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  VersioningOverride.Builder
      Used to override the versioning behavior (and pinned deployment version, if applicable) of a specific workflow execution.
      static class  VersioningOverride.OverrideCase  
      static class  VersioningOverride.PinnedOverride
      Protobuf type temporal.api.workflow.v1.VersioningOverride.PinnedOverride
      static class  VersioningOverride.PinnedOverrideBehavior
      Used to specify different sub-types of Pinned override that we plan to add in the future.
      static interface  VersioningOverride.PinnedOverrideOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static VersioningOverride parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VersioningOverride parseFrom​(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VersioningOverride parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VersioningOverride parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VersioningOverride parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VersioningOverride parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VersioningOverride parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static VersioningOverride parseFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static VersioningOverride parseDelimitedFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static VersioningOverride parseDelimitedFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static VersioningOverride parseFrom​(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static VersioningOverride parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected VersioningOverride.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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

      • getDefaultInstanceForType

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