Package io.temporal.api.workflowservice.v1

Class SetWorkerDeploymentRampingVersionRequest.Builder

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public SetWorkerDeploymentRampingVersionRequest.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<SetWorkerDeploymentRampingVersionRequest.Builder>
        Throws:
        java.io.IOException

      • setNamespaceBytes

        public SetWorkerDeploymentRampingVersionRequest.Builder setNamespaceBytes​(com.google.protobuf.ByteString value)
        string namespace = 1;
        Parameters:
        value - The bytes for namespace to set.
        Returns:
        This builder for chaining.

      • setDeploymentNameBytes

        public SetWorkerDeploymentRampingVersionRequest.Builder setDeploymentNameBytes​(com.google.protobuf.ByteString value)
        string deployment_name = 2;
        Parameters:
        value - The bytes for deploymentName to set.
        Returns:
        This builder for chaining.

      • getVersion

        @Deprecated
public 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];
        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=2185
         Deprecated. Use `build_id`.
        string version = 3 [deprecated = true];
        Specified by:
        getVersionBytes in interface SetWorkerDeploymentRampingVersionRequestOrBuilder
        Returns:
        The bytes for version.

      • setVersion

        @Deprecated
public SetWorkerDeploymentRampingVersionRequest.Builder setVersion​(java.lang.String value)
        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];
        Parameters:
        value - The version to set.
        Returns:
        This builder for chaining.

      • clearVersion

        @Deprecated
public SetWorkerDeploymentRampingVersionRequest.Builder clearVersion()
        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:
        This builder for chaining.

      • setVersionBytes

        @Deprecated
public SetWorkerDeploymentRampingVersionRequest.Builder setVersionBytes​(com.google.protobuf.ByteString value)
        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];
        Parameters:
        value - The bytes for version to set.
        Returns:
        This builder for chaining.

      • getBuildId

        public 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;
        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.

      • setBuildId

        public SetWorkerDeploymentRampingVersionRequest.Builder setBuildId​(java.lang.String value)
         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;
        Parameters:
        value - The buildId to set.
        Returns:
        This builder for chaining.

      • clearBuildId

        public SetWorkerDeploymentRampingVersionRequest.Builder clearBuildId()
         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:
        This builder for chaining.

      • setBuildIdBytes

        public SetWorkerDeploymentRampingVersionRequest.Builder setBuildIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for buildId to set.
        Returns:
        This builder for chaining.

      • setPercentage

        public SetWorkerDeploymentRampingVersionRequest.Builder setPercentage​(float value)
         Ramp percentage to set. Valid range: [0,100].
        float percentage = 4;
        Parameters:
        value - The percentage to set.
        Returns:
        This builder for chaining.

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

      • setConflictToken

        public SetWorkerDeploymentRampingVersionRequest.Builder setConflictToken​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The conflictToken to set.
        Returns:
        This builder for chaining.

      • clearConflictToken

        public SetWorkerDeploymentRampingVersionRequest.Builder clearConflictToken()
         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:
        This builder for chaining.

      • setIdentity

        public SetWorkerDeploymentRampingVersionRequest.Builder setIdentity​(java.lang.String value)
         Optional. The identity of the client who initiated this request.
        string identity = 6;
        Parameters:
        value - The identity to set.
        Returns:
        This builder for chaining.

      • setIdentityBytes

        public SetWorkerDeploymentRampingVersionRequest.Builder setIdentityBytes​(com.google.protobuf.ByteString value)
         Optional. The identity of the client who initiated this request.
        string identity = 6;
        Parameters:
        value - The bytes for identity to set.
        Returns:
        This builder for chaining.

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

      • setIgnoreMissingTaskQueues

        public SetWorkerDeploymentRampingVersionRequest.Builder setIgnoreMissingTaskQueues​(boolean value)
         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;
        Parameters:
        value - The ignoreMissingTaskQueues to set.
        Returns:
        This builder for chaining.

      • clearIgnoreMissingTaskQueues

        public SetWorkerDeploymentRampingVersionRequest.Builder clearIgnoreMissingTaskQueues()
         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:
        This builder for chaining.

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

      • setAllowNoPollers

        public SetWorkerDeploymentRampingVersionRequest.Builder setAllowNoPollers​(boolean value)
         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;
        Parameters:
        value - The allowNoPollers to set.
        Returns:
        This builder for chaining.

      • clearAllowNoPollers

        public SetWorkerDeploymentRampingVersionRequest.Builder clearAllowNoPollers()
         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;
        Returns:
        This builder for chaining.