Package io.temporal.api.deployment.v1

Class WorkerDeploymentVersionInfo

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WorkerDeploymentVersionInfoOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:WorkerDeploymentVersionInfo.java.pb.meta")
public final class WorkerDeploymentVersionInfo
extends com.google.protobuf.GeneratedMessageV3
implements WorkerDeploymentVersionInfoOrBuilder
     A Worker Deployment Version (Version, for short) represents all workers of the same 
 code and config within a Deployment. Workers of the same Version are expected to 
 behave exactly the same so when executions move between them there are no 
 non-determinism issues.
 Worker Deployment Versions are created in Temporal server automatically when 
 their first poller arrives to the server.
 Experimental. Worker Deployments are experimental and might significantly change in the future.
    Protobuf type temporal.api.deployment.v1.WorkerDeploymentVersionInfo
    See Also:
    Serialized Form

    • Field Detail

      • DEPLOYMENT_VERSION_FIELD_NUMBER

        public static final int DEPLOYMENT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPLOYMENT_NAME_FIELD_NUMBER

        public static final int DEPLOYMENT_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROUTING_CHANGED_TIME_FIELD_NUMBER

        public static final int ROUTING_CHANGED_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_SINCE_TIME_FIELD_NUMBER

        public static final int CURRENT_SINCE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMPING_SINCE_TIME_FIELD_NUMBER

        public static final int RAMPING_SINCE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FIRST_ACTIVATION_TIME_FIELD_NUMBER

        public static final int FIRST_ACTIVATION_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LAST_DEACTIVATION_TIME_FIELD_NUMBER

        public static final int LAST_DEACTIVATION_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMP_PERCENTAGE_FIELD_NUMBER

        public static final int RAMP_PERCENTAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_INFOS_FIELD_NUMBER

        public static final int TASK_QUEUE_INFOS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DRAINAGE_INFO_FIELD_NUMBER

        public static final int DRAINAGE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getVersion

        @Deprecated
public java.lang.String getVersion()
        Deprecated.
        temporal.api.deployment.v1.WorkerDeploymentVersionInfo.version is deprecated. See temporal/api/deployment/v1/message.proto;l=97
         Deprecated. Use `deployment_version`.
        string version = 1 [deprecated = true];
        Specified by:
        getVersion in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The version.

      • getVersionBytes

        @Deprecated
public com.google.protobuf.ByteString getVersionBytes()
        Deprecated.
        temporal.api.deployment.v1.WorkerDeploymentVersionInfo.version is deprecated. See temporal/api/deployment/v1/message.proto;l=97
         Deprecated. Use `deployment_version`.
        string version = 1 [deprecated = true];
        Specified by:
        getVersionBytes in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The bytes for version.

      • getStatusValue

        public int getStatusValue()
         The status of the Worker Deployment Version.
        .temporal.api.enums.v1.WorkerDeploymentVersionStatus status = 14;
        Specified by:
        getStatusValue in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • hasDeploymentVersion

        public boolean hasDeploymentVersion()
         Required.
        .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 11;
        Specified by:
        hasDeploymentVersion in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the deploymentVersion field is set.

      • hasRoutingChangedTime

        public boolean hasRoutingChangedTime()
         Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
        .google.protobuf.Timestamp routing_changed_time = 4;
        Specified by:
        hasRoutingChangedTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the routingChangedTime field is set.

      • getRoutingChangedTime

        public com.google.protobuf.Timestamp getRoutingChangedTime()
         Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
        .google.protobuf.Timestamp routing_changed_time = 4;
        Specified by:
        getRoutingChangedTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The routingChangedTime.

      • getRoutingChangedTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getRoutingChangedTimeOrBuilder()
         Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
        .google.protobuf.Timestamp routing_changed_time = 4;
        Specified by:
        getRoutingChangedTimeOrBuilder in interface WorkerDeploymentVersionInfoOrBuilder

      • hasCurrentSinceTime

        public boolean hasCurrentSinceTime()
         (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
 Unset if not current.
        .google.protobuf.Timestamp current_since_time = 5;
        Specified by:
        hasCurrentSinceTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the currentSinceTime field is set.

      • getCurrentSinceTime

        public com.google.protobuf.Timestamp getCurrentSinceTime()
         (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
 Unset if not current.
        .google.protobuf.Timestamp current_since_time = 5;
        Specified by:
        getCurrentSinceTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The currentSinceTime.

      • getCurrentSinceTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCurrentSinceTimeOrBuilder()
         (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
 Unset if not current.
        .google.protobuf.Timestamp current_since_time = 5;
        Specified by:
        getCurrentSinceTimeOrBuilder in interface WorkerDeploymentVersionInfoOrBuilder

      • hasRampingSinceTime

        public boolean hasRampingSinceTime()
         (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
 Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
        .google.protobuf.Timestamp ramping_since_time = 6;
        Specified by:
        hasRampingSinceTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the rampingSinceTime field is set.

      • getRampingSinceTime

        public com.google.protobuf.Timestamp getRampingSinceTime()
         (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
 Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
        .google.protobuf.Timestamp ramping_since_time = 6;
        Specified by:
        getRampingSinceTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The rampingSinceTime.

      • getRampingSinceTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getRampingSinceTimeOrBuilder()
         (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
 Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
        .google.protobuf.Timestamp ramping_since_time = 6;
        Specified by:
        getRampingSinceTimeOrBuilder in interface WorkerDeploymentVersionInfoOrBuilder

      • hasFirstActivationTime

        public boolean hasFirstActivationTime()
         Timestamp when this version first became current or ramping.
        .google.protobuf.Timestamp first_activation_time = 12;
        Specified by:
        hasFirstActivationTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the firstActivationTime field is set.

      • getFirstActivationTime

        public com.google.protobuf.Timestamp getFirstActivationTime()
         Timestamp when this version first became current or ramping.
        .google.protobuf.Timestamp first_activation_time = 12;
        Specified by:
        getFirstActivationTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The firstActivationTime.

      • hasLastDeactivationTime

        public boolean hasLastDeactivationTime()
         Timestamp when this version last stopped being current or ramping.
        .google.protobuf.Timestamp last_deactivation_time = 13;
        Specified by:
        hasLastDeactivationTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the lastDeactivationTime field is set.

      • getLastDeactivationTime

        public com.google.protobuf.Timestamp getLastDeactivationTime()
         Timestamp when this version last stopped being current or ramping.
        .google.protobuf.Timestamp last_deactivation_time = 13;
        Specified by:
        getLastDeactivationTime in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The lastDeactivationTime.

      • getRampPercentage

        public float getRampPercentage()
         Range: [0, 100]. Must be zero if the version is not ramping (i.e. `ramping_since_time` is nil).
 Can be in the range [0, 100] if the version is ramping.
        float ramp_percentage = 7;
        Specified by:
        getRampPercentage in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The rampPercentage.

      • getTaskQueueInfosCount

        public int getTaskQueueInfosCount()
         All the Task Queues that have ever polled from this Deployment version.
 Deprecated. Use `version_task_queues` in DescribeWorkerDeploymentVersionResponse instead.
        repeated .temporal.api.deployment.v1.WorkerDeploymentVersionInfo.VersionTaskQueueInfo task_queue_infos = 8;
        Specified by:
        getTaskQueueInfosCount in interface WorkerDeploymentVersionInfoOrBuilder

      • hasDrainageInfo

        public boolean hasDrainageInfo()
         Helps user determine when it is safe to decommission the workers of this
 Version. Not present when version is current or ramping.
 Current limitations:
 - Not supported for Unversioned mode.
 - Periodically refreshed, may have delays up to few minutes (consult the
   last_checked_time value).
 - Refreshed only when version is not current or ramping AND the status is not
   "drained" yet.
 - Once the status is changed to "drained", it is not changed until the Version
   becomes Current or Ramping again, at which time the drainage info is cleared.
   This means if the Version is "drained" but new workflows are sent to it via
   Pinned Versioning Override, the status does not account for those Pinned-override
   executions and remains "drained".
        .temporal.api.deployment.v1.VersionDrainageInfo drainage_info = 9;
        Specified by:
        hasDrainageInfo in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the drainageInfo field is set.

      • getDrainageInfo

        public VersionDrainageInfo getDrainageInfo()
         Helps user determine when it is safe to decommission the workers of this
 Version. Not present when version is current or ramping.
 Current limitations:
 - Not supported for Unversioned mode.
 - Periodically refreshed, may have delays up to few minutes (consult the
   last_checked_time value).
 - Refreshed only when version is not current or ramping AND the status is not
   "drained" yet.
 - Once the status is changed to "drained", it is not changed until the Version
   becomes Current or Ramping again, at which time the drainage info is cleared.
   This means if the Version is "drained" but new workflows are sent to it via
   Pinned Versioning Override, the status does not account for those Pinned-override
   executions and remains "drained".
        .temporal.api.deployment.v1.VersionDrainageInfo drainage_info = 9;
        Specified by:
        getDrainageInfo in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        The drainageInfo.

      • getDrainageInfoOrBuilder

        public VersionDrainageInfoOrBuilder getDrainageInfoOrBuilder()
         Helps user determine when it is safe to decommission the workers of this
 Version. Not present when version is current or ramping.
 Current limitations:
 - Not supported for Unversioned mode.
 - Periodically refreshed, may have delays up to few minutes (consult the
   last_checked_time value).
 - Refreshed only when version is not current or ramping AND the status is not
   "drained" yet.
 - Once the status is changed to "drained", it is not changed until the Version
   becomes Current or Ramping again, at which time the drainage info is cleared.
   This means if the Version is "drained" but new workflows are sent to it via
   Pinned Versioning Override, the status does not account for those Pinned-override
   executions and remains "drained".
        .temporal.api.deployment.v1.VersionDrainageInfo drainage_info = 9;
        Specified by:
        getDrainageInfoOrBuilder in interface WorkerDeploymentVersionInfoOrBuilder

      • hasMetadata

        public boolean hasMetadata()
         Arbitrary user-provided metadata attached to this version.
        .temporal.api.deployment.v1.VersionMetadata metadata = 10;
        Specified by:
        hasMetadata in interface WorkerDeploymentVersionInfoOrBuilder
        Returns:
        Whether the metadata field is set.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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