Class VersioningOverride

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.workflow.v1.VersioningOverride
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, VersioningOverrideOrBuilder, 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, this override takes precedence over 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 behavior overrides are automatically inherited by child workflows, workflow retries, continue-as-new
 workflows, and cron workflows.
Protobuf type temporal.api.workflow.v1.VersioningOverride
See Also:

  • Field Details

    • PINNED_FIELD_NUMBER

      public static final int PINNED_FIELD_NUMBER
      See Also:

    • AUTO_UPGRADE_FIELD_NUMBER

      public static final int AUTO_UPGRADE_FIELD_NUMBER
      See Also:

    • ONE_TIME_FIELD_NUMBER

      public static final int ONE_TIME_FIELD_NUMBER
      See Also:

    • BEHAVIOR_FIELD_NUMBER

      public static final int BEHAVIOR_FIELD_NUMBER
      See Also:

    • DEPLOYMENT_FIELD_NUMBER

      public static final int DEPLOYMENT_FIELD_NUMBER
      See Also:

    • PINNED_VERSION_FIELD_NUMBER

      public static final int PINNED_VERSION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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

    • getOverrideCase

      public VersioningOverride.OverrideCase getOverrideCase()
      Specified by:
      getOverrideCase in interface VersioningOverrideOrBuilder

    • hasPinned

      public boolean hasPinned()
       Override the workflow to have Pinned behavior. This is a sticky override:
 Workflow Tasks continue to route according to this override until it is
 explicitly removed.
      .temporal.api.workflow.v1.VersioningOverride.PinnedOverride pinned = 3;
      Specified by:
      hasPinned in interface VersioningOverrideOrBuilder
      Returns:
      Whether the pinned field is set.

    • getPinned

      public VersioningOverride.PinnedOverride getPinned()
       Override the workflow to have Pinned behavior. This is a sticky override:
 Workflow Tasks continue to route according to this override until it is
 explicitly removed.
      .temporal.api.workflow.v1.VersioningOverride.PinnedOverride pinned = 3;
      Specified by:
      getPinned in interface VersioningOverrideOrBuilder
      Returns:
      The pinned.

    • getPinnedOrBuilder

      public VersioningOverride.PinnedOverrideOrBuilder getPinnedOrBuilder()
       Override the workflow to have Pinned behavior. This is a sticky override:
 Workflow Tasks continue to route according to this override until it is
 explicitly removed.
      .temporal.api.workflow.v1.VersioningOverride.PinnedOverride pinned = 3;
      Specified by:
      getPinnedOrBuilder in interface VersioningOverrideOrBuilder

    • hasAutoUpgrade

      public boolean hasAutoUpgrade()
       Override the workflow to have AutoUpgrade behavior.
      bool auto_upgrade = 4;
      Specified by:
      hasAutoUpgrade in interface VersioningOverrideOrBuilder
      Returns:
      Whether the autoUpgrade field is set.

    • getAutoUpgrade

      public boolean getAutoUpgrade()
       Override the workflow to have AutoUpgrade behavior.
      bool auto_upgrade = 4;
      Specified by:
      getAutoUpgrade in interface VersioningOverrideOrBuilder
      Returns:
      The autoUpgrade.

    • hasOneTime

      public boolean hasOneTime()
       Override Workflow Task routing to a specific Worker Deployment Version until
 one Workflow Task completes there. After completion, the workflow execution's
 Versioning Behavior and Deployment Version come from the worker's completion
 response.
 (-- api-linter: core::0142::time-field-type=disabled
     aip.dev/not-precedent: one_time describes one-time routing semantics, not a timestamp or duration. --)
      .temporal.api.workflow.v1.VersioningOverride.OneTimeOverride one_time = 5;
      Specified by:
      hasOneTime in interface VersioningOverrideOrBuilder
      Returns:
      Whether the oneTime field is set.

    • getOneTime

      public VersioningOverride.OneTimeOverride getOneTime()
       Override Workflow Task routing to a specific Worker Deployment Version until
 one Workflow Task completes there. After completion, the workflow execution's
 Versioning Behavior and Deployment Version come from the worker's completion
 response.
 (-- api-linter: core::0142::time-field-type=disabled
     aip.dev/not-precedent: one_time describes one-time routing semantics, not a timestamp or duration. --)
      .temporal.api.workflow.v1.VersioningOverride.OneTimeOverride one_time = 5;
      Specified by:
      getOneTime in interface VersioningOverrideOrBuilder
      Returns:
      The oneTime.

    • getOneTimeOrBuilder

      public VersioningOverride.OneTimeOverrideOrBuilder getOneTimeOrBuilder()
       Override Workflow Task routing to a specific Worker Deployment Version until
 one Workflow Task completes there. After completion, the workflow execution's
 Versioning Behavior and Deployment Version come from the worker's completion
 response.
 (-- api-linter: core::0142::time-field-type=disabled
     aip.dev/not-precedent: one_time describes one-time routing semantics, not a timestamp or duration. --)
      .temporal.api.workflow.v1.VersioningOverride.OneTimeOverride one_time = 5;
      Specified by:
      getOneTimeOrBuilder in interface VersioningOverrideOrBuilder

    • getBehaviorValue

      @Deprecated public int getBehaviorValue()
      Deprecated.
      temporal.api.workflow.v1.VersioningOverride.behavior is deprecated. See temporal/api/workflow/v1/message.proto;l=630
       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=630
       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=635
       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=635
       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 String getPinnedVersion()
      Deprecated.
      temporal.api.workflow.v1.VersioningOverride.pinned_version is deprecated. See temporal/api/workflow/v1/message.proto;l=641
       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=641
       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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VersioningOverride parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static VersioningOverride parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static VersioningOverride.Builder newBuilder()

    • newBuilder

      public static VersioningOverride.Builder newBuilder(VersioningOverride prototype)

    • 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

    • getDefaultInstance

      public static VersioningOverride getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<VersioningOverride> parser()

    • 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