Package io.temporal.api.deployment.v1

Interface WorkerDeploymentVersionInfoOrBuilder

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

    • Method Detail

      • getVersion

        java.lang.String getVersion()
         The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".
        string version = 1;
        Returns:
        The version.

      • getVersionBytes

        com.google.protobuf.ByteString getVersionBytes()
         The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".
        string version = 1;
        Returns:
        The bytes for version.

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

      • hasCreateTime

        boolean hasCreateTime()
        .google.protobuf.Timestamp create_time = 3;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
        .google.protobuf.Timestamp create_time = 3;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
        .google.protobuf.Timestamp create_time = 3;

      • hasRoutingChangedTime

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

      • getRoutingChangedTime

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

      • getRoutingChangedTimeOrBuilder

        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;

      • hasCurrentSinceTime

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

      • getCurrentSinceTime

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

      • getCurrentSinceTimeOrBuilder

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

      • hasRampingSinceTime

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

      • getRampingSinceTime

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

      • getRampingSinceTimeOrBuilder

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

      • getRampPercentage

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

      • getTaskQueueInfosList

        java.util.List<WorkerDeploymentVersionInfo.VersionTaskQueueInfo> getTaskQueueInfosList()
         All the Task Queues that have ever polled from this Deployment version.
        repeated .temporal.api.deployment.v1.WorkerDeploymentVersionInfo.VersionTaskQueueInfo task_queue_infos = 8;

      • getTaskQueueInfos

        WorkerDeploymentVersionInfo.VersionTaskQueueInfo getTaskQueueInfos​(int index)
         All the Task Queues that have ever polled from this Deployment version.
        repeated .temporal.api.deployment.v1.WorkerDeploymentVersionInfo.VersionTaskQueueInfo task_queue_infos = 8;

      • getTaskQueueInfosCount

        int getTaskQueueInfosCount()
         All the Task Queues that have ever polled from this Deployment version.
        repeated .temporal.api.deployment.v1.WorkerDeploymentVersionInfo.VersionTaskQueueInfo task_queue_infos = 8;

      • getTaskQueueInfosOrBuilderList

        java.util.List<? extends WorkerDeploymentVersionInfo.VersionTaskQueueInfoOrBuilder> getTaskQueueInfosOrBuilderList()
         All the Task Queues that have ever polled from this Deployment version.
        repeated .temporal.api.deployment.v1.WorkerDeploymentVersionInfo.VersionTaskQueueInfo task_queue_infos = 8;

      • getTaskQueueInfosOrBuilder

        WorkerDeploymentVersionInfo.VersionTaskQueueInfoOrBuilder getTaskQueueInfosOrBuilder​(int index)
         All the Task Queues that have ever polled from this Deployment version.
        repeated .temporal.api.deployment.v1.WorkerDeploymentVersionInfo.VersionTaskQueueInfo task_queue_infos = 8;

      • hasDrainageInfo

        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;
        Returns:
        Whether the drainageInfo field is set.

      • getDrainageInfo

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

      • getDrainageInfoOrBuilder

        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;

      • hasMetadata

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

      • getMetadata

        VersionMetadata getMetadata()
         Arbitrary user-provided metadata attached to this version.
        .temporal.api.deployment.v1.VersionMetadata metadata = 10;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        VersionMetadataOrBuilder getMetadataOrBuilder()
         Arbitrary user-provided metadata attached to this version.
        .temporal.api.deployment.v1.VersionMetadata metadata = 10;