Class SetWorkerDeploymentRampingVersionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SetWorkerDeploymentRampingVersionRequestOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:SetWorkerDeploymentRampingVersionRequest.java.pb.meta") public final class SetWorkerDeploymentRampingVersionRequest extends com.google.protobuf.GeneratedMessageV3 implements SetWorkerDeploymentRampingVersionRequestOrBuilder
 Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.
Protobuf type temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest
See Also:

  • Field Details

    • NAMESPACE_FIELD_NUMBER

      public static final int NAMESPACE_FIELD_NUMBER
      See Also:

    • DEPLOYMENT_NAME_FIELD_NUMBER

      public static final int DEPLOYMENT_NAME_FIELD_NUMBER
      See Also:

    • VERSION_FIELD_NUMBER

      public static final int VERSION_FIELD_NUMBER
      See Also:

    • BUILD_ID_FIELD_NUMBER

      public static final int BUILD_ID_FIELD_NUMBER
      See Also:

    • PERCENTAGE_FIELD_NUMBER

      public static final int PERCENTAGE_FIELD_NUMBER
      See Also:

    • CONFLICT_TOKEN_FIELD_NUMBER

      public static final int CONFLICT_TOKEN_FIELD_NUMBER
      See Also:

    • IDENTITY_FIELD_NUMBER

      public static final int IDENTITY_FIELD_NUMBER
      See Also:

    • IGNORE_MISSING_TASK_QUEUES_FIELD_NUMBER

      public static final int IGNORE_MISSING_TASK_QUEUES_FIELD_NUMBER
      See Also:

    • ALLOW_NO_POLLERS_FIELD_NUMBER

      public static final int ALLOW_NO_POLLERS_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

    • getNamespace

      public String getNamespace()
      string namespace = 1;
      Specified by:
      getNamespace in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The namespace.

    • getNamespaceBytes

      public com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      Specified by:
      getNamespaceBytes in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The bytes for namespace.

    • getDeploymentName

      public String getDeploymentName()
      string deployment_name = 2;
      Specified by:
      getDeploymentName in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The deploymentName.

    • getDeploymentNameBytes

      public com.google.protobuf.ByteString getDeploymentNameBytes()
      string deployment_name = 2;
      Specified by:
      getDeploymentNameBytes in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The bytes for deploymentName.

    • getVersion

      @Deprecated public String getVersion()
      Deprecated.
      temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.version is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=2597
       Deprecated. Use `build_id`.
      string version = 3 [deprecated = true];
      Specified by:
      getVersion in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The version.

    • getVersionBytes

      @Deprecated public com.google.protobuf.ByteString getVersionBytes()
      Deprecated.
      temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.version is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=2597
       Deprecated. Use `build_id`.
      string version = 3 [deprecated = true];
      Specified by:
      getVersionBytes in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The bytes for version.

    • getBuildId

      public String getBuildId()
       The build id of the Version that you want to ramp traffic to.
 Pass an empty value to set the Ramping Version to nil.
 A nil Ramping Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
      string build_id = 8;
      Specified by:
      getBuildId in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The buildId.

    • getBuildIdBytes

      public com.google.protobuf.ByteString getBuildIdBytes()
       The build id of the Version that you want to ramp traffic to.
 Pass an empty value to set the Ramping Version to nil.
 A nil Ramping Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
      string build_id = 8;
      Specified by:
      getBuildIdBytes in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The bytes for buildId.

    • getPercentage

      public float getPercentage()
       Ramp percentage to set. Valid range: [0,100].
      float percentage = 4;
      Specified by:
      getPercentage in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The percentage.

    • getConflictToken

      public com.google.protobuf.ByteString getConflictToken()
       Optional. This can be the value of conflict_token from a Describe, or another Worker
 Deployment API. Passing a non-nil conflict token will cause this request to fail if the
 Deployment's configuration has been modified between the API call that generated the
 token and this one.
      bytes conflict_token = 5;
      Specified by:
      getConflictToken in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The conflictToken.

    • getIdentity

      public String getIdentity()
       Optional. The identity of the client who initiated this request.
      string identity = 6;
      Specified by:
      getIdentity in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The identity.

    • getIdentityBytes

      public com.google.protobuf.ByteString getIdentityBytes()
       Optional. The identity of the client who initiated this request.
      string identity = 6;
      Specified by:
      getIdentityBytes in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The bytes for identity.

    • getIgnoreMissingTaskQueues

      public boolean getIgnoreMissingTaskQueues()
       Optional. By default this request would be rejected if not all the expected Task Queues are
 being polled by the new Version, to protect against accidental removal of Task Queues, or
 worker health issues. Pass `true` here to bypass this protection.
 The set of expected Task Queues equals to all the Task Queues ever polled from the existing
 Current Version of the Deployment, with the following exclusions:
   - Task Queues that are not used anymore (inferred by having empty backlog and a task
     add_rate of 0.)
   - Task Queues that are moved to another Worker Deployment (inferred by the Task Queue
     having a different Current Version than the Current Version of this deployment.)
 WARNING: Do not set this flag unless you are sure that the missing task queue poller are not
 needed. If the request is unexpectedly rejected due to missing pollers, then that means the
 pollers have not reached to the server yet. Only set this if you expect those pollers to
 never arrive.
 Note: this check only happens when the ramping version is about to change, not every time
 that the percentage changes. Also note that the check is against the deployment's Current
 Version, not the previous Ramping Version.
      bool ignore_missing_task_queues = 7;
      Specified by:
      getIgnoreMissingTaskQueues in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The ignoreMissingTaskQueues.

    • getAllowNoPollers

      public boolean getAllowNoPollers()
       Optional. By default this request will be rejected if no pollers have been seen for the proposed
 Current Version, in order to protect users from routing tasks to pollers that do not exist, leading
 to possible timeouts. Pass `true` here to bypass this protection.
      bool allow_no_pollers = 10;
      Specified by:
      getAllowNoPollers in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
      Returns:
      The allowNoPollers.

    • 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 SetWorkerDeploymentRampingVersionRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SetWorkerDeploymentRampingVersionRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SetWorkerDeploymentRampingVersionRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SetWorkerDeploymentRampingVersionRequest.Builder newBuilder()

    • newBuilder

      public static SetWorkerDeploymentRampingVersionRequest.Builder newBuilder(SetWorkerDeploymentRampingVersionRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SetWorkerDeploymentRampingVersionRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SetWorkerDeploymentRampingVersionRequest> 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 SetWorkerDeploymentRampingVersionRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder