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 Details

    • getVersion

      @Deprecated 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];
      Returns:
      The version.

    • getVersionBytes

      @Deprecated 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];
      Returns:
      The bytes for version.

    • getStatusValue

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

    • getStatus

      WorkerDeploymentVersionStatus getStatus()
       The status of the Worker Deployment Version.
      .temporal.api.enums.v1.WorkerDeploymentVersionStatus status = 14;
      Returns:
      The status.

    • hasDeploymentVersion

      boolean hasDeploymentVersion()
       Required.
      .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 11;
      Returns:
      Whether the deploymentVersion field is set.

    • getDeploymentVersion

      WorkerDeploymentVersion getDeploymentVersion()
       Required.
      .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 11;
      Returns:
      The deploymentVersion.

    • getDeploymentVersionOrBuilder

      WorkerDeploymentVersionOrBuilder getDeploymentVersionOrBuilder()
       Required.
      .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 11;

    • getDeploymentName

      String getDeploymentName()
       Deprecated. User deployment_version.deployment_name.
      string deployment_name = 2;
      Returns:
      The deploymentName.

    • getDeploymentNameBytes

      com.google.protobuf.ByteString getDeploymentNameBytes()
       Deprecated. User deployment_version.deployment_name.
      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. --)
 Unset 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. --)
 Unset 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. --)
 Unset 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. --)
 Unset 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. --)
 Unset 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. --)
 Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
      .google.protobuf.Timestamp ramping_since_time = 6;

    • hasFirstActivationTime

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

    • getFirstActivationTime

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

    • getFirstActivationTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getFirstActivationTimeOrBuilder()
       Timestamp when this version first became current or ramping.
      .google.protobuf.Timestamp first_activation_time = 12;

    • hasLastCurrentTime

      boolean hasLastCurrentTime()
       Timestamp when this version last became current.
 Can be used to determine whether a version has ever been Current.
      .google.protobuf.Timestamp last_current_time = 15;
      Returns:
      Whether the lastCurrentTime field is set.

    • getLastCurrentTime

      com.google.protobuf.Timestamp getLastCurrentTime()
       Timestamp when this version last became current.
 Can be used to determine whether a version has ever been Current.
      .google.protobuf.Timestamp last_current_time = 15;
      Returns:
      The lastCurrentTime.

    • getLastCurrentTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getLastCurrentTimeOrBuilder()
       Timestamp when this version last became current.
 Can be used to determine whether a version has ever been Current.
      .google.protobuf.Timestamp last_current_time = 15;

    • hasLastDeactivationTime

      boolean hasLastDeactivationTime()
       Timestamp when this version last stopped being current or ramping.
 Cleared if the version becomes current or ramping again.
      .google.protobuf.Timestamp last_deactivation_time = 13;
      Returns:
      Whether the lastDeactivationTime field is set.

    • getLastDeactivationTime

      com.google.protobuf.Timestamp getLastDeactivationTime()
       Timestamp when this version last stopped being current or ramping.
 Cleared if the version becomes current or ramping again.
      .google.protobuf.Timestamp last_deactivation_time = 13;
      Returns:
      The lastDeactivationTime.

    • getLastDeactivationTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getLastDeactivationTimeOrBuilder()
       Timestamp when this version last stopped being current or ramping.
 Cleared if the version becomes current or ramping again.
      .google.protobuf.Timestamp last_deactivation_time = 13;

    • 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

      List<WorkerDeploymentVersionInfo.VersionTaskQueueInfo> getTaskQueueInfosList()
       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;

    • getTaskQueueInfos

      WorkerDeploymentVersionInfo.VersionTaskQueueInfo getTaskQueueInfos(int index)
       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;

    • getTaskQueueInfosCount

      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;

    • getTaskQueueInfosOrBuilderList

      List<? extends WorkerDeploymentVersionInfo.VersionTaskQueueInfoOrBuilder> getTaskQueueInfosOrBuilderList()
       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;

    • getTaskQueueInfosOrBuilder

      WorkerDeploymentVersionInfo.VersionTaskQueueInfoOrBuilder getTaskQueueInfosOrBuilder(int index)
       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;

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

    • hasComputeConfig

      boolean hasComputeConfig()
       Optional. Contains the new worker compute configuration for the Worker
 Deployment. Used for worker scale management.
      .temporal.api.compute.v1.ComputeConfig compute_config = 16;
      Returns:
      Whether the computeConfig field is set.

    • getComputeConfig

      ComputeConfig getComputeConfig()
       Optional. Contains the new worker compute configuration for the Worker
 Deployment. Used for worker scale management.
      .temporal.api.compute.v1.ComputeConfig compute_config = 16;
      Returns:
      The computeConfig.

    • getComputeConfigOrBuilder

      ComputeConfigOrBuilder getComputeConfigOrBuilder()
       Optional. Contains the new worker compute configuration for the Worker
 Deployment. Used for worker scale management.
      .temporal.api.compute.v1.ComputeConfig compute_config = 16;

    • getLastModifierIdentity

      String getLastModifierIdentity()
       Identity of the last client who modified the configuration of this Version.
 As of now, this field only covers changes through the following APIs:
 - `CreateWorkerDeploymentVersion`
 - `UpdateWorkerDeploymentVersionComputeConfig`
 - `UpdateWorkerDeploymentVersionMetadata`
      string last_modifier_identity = 17;
      Returns:
      The lastModifierIdentity.

    • getLastModifierIdentityBytes

      com.google.protobuf.ByteString getLastModifierIdentityBytes()
       Identity of the last client who modified the configuration of this Version.
 As of now, this field only covers changes through the following APIs:
 - `CreateWorkerDeploymentVersion`
 - `UpdateWorkerDeploymentVersionComputeConfig`
 - `UpdateWorkerDeploymentVersionMetadata`
      string last_modifier_identity = 17;
      Returns:
      The bytes for lastModifierIdentity.