Package io.temporal.api.workflowservice.v1

Interface SetWorkerDeploymentRampingVersionRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SetWorkerDeploymentRampingVersionRequest, SetWorkerDeploymentRampingVersionRequest.Builder
    @Generated(value="protoc",
           comments="annotations:SetWorkerDeploymentRampingVersionRequestOrBuilder.java.pb.meta")
public interface SetWorkerDeploymentRampingVersionRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getBuildId()
      The build id of the Version that you want to ramp traffic to.
      com.google.protobuf.ByteString getBuildIdBytes()
      The build id of the Version that you want to ramp traffic to.
      com.google.protobuf.ByteString getConflictToken()
      Optional.
      java.lang.String getDeploymentName()
      string deployment_name = 2;
      com.google.protobuf.ByteString getDeploymentNameBytes()
      string deployment_name = 2;
      java.lang.String getIdentity()
      Optional.
      com.google.protobuf.ByteString getIdentityBytes()
      Optional.
      boolean getIgnoreMissingTaskQueues()
      Optional.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      float getPercentage()
      Ramp percentage to set.
      java.lang.String getVersion()
      Deprecated.
      temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.version is deprecated.
      com.google.protobuf.ByteString getVersionBytes()
      Deprecated.
      temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.version is deprecated.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • getDeploymentName

        java.lang.String getDeploymentName()
        string deployment_name = 2;
        Returns:
        The deploymentName.

      • getDeploymentNameBytes

        com.google.protobuf.ByteString getDeploymentNameBytes()
        string deployment_name = 2;
        Returns:
        The bytes for deploymentName.

      • getVersion

        @Deprecated
java.lang.String getVersion()
        Deprecated.
        temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.version is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=2185
         Deprecated. Use `build_id`.
        string version = 3 [deprecated = true];
        Returns:
        The version.

      • getVersionBytes

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

      • getBuildId

        java.lang.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;
        Returns:
        The buildId.

      • getBuildIdBytes

        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;
        Returns:
        The bytes for buildId.

      • getPercentage

        float getPercentage()
         Ramp percentage to set. Valid range: [0,100].
        float percentage = 4;
        Returns:
        The percentage.

      • getConflictToken

        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;
        Returns:
        The conflictToken.

      • getIdentity

        java.lang.String getIdentity()
         Optional. The identity of the client who initiated this request.
        string identity = 6;
        Returns:
        The identity.

      • getIdentityBytes

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

      • getIgnoreMissingTaskQueues

        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;
        Returns:
        The ignoreMissingTaskQueues.