Interface DescribeTaskQueueResponseOrBuilder

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

  • Method Details

    • getPollersList

      List<PollerInfo> getPollersList()
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;

    • getPollers

      PollerInfo getPollers(int index)
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;

    • getPollersCount

      int getPollersCount()
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;

    • getPollersOrBuilderList

      List<? extends PollerInfoOrBuilder> getPollersOrBuilderList()
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;

    • getPollersOrBuilder

      PollerInfoOrBuilder getPollersOrBuilder(int index)
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;

    • hasStats

      boolean hasStats()
       Statistics for the task queue.
 Only set if `report_stats` is set on the request.
      .temporal.api.taskqueue.v1.TaskQueueStats stats = 5;
      Returns:
      Whether the stats field is set.

    • getStats

      TaskQueueStats getStats()
       Statistics for the task queue.
 Only set if `report_stats` is set on the request.
      .temporal.api.taskqueue.v1.TaskQueueStats stats = 5;
      Returns:
      The stats.

    • getStatsOrBuilder

      TaskQueueStatsOrBuilder getStatsOrBuilder()
       Statistics for the task queue.
 Only set if `report_stats` is set on the request.
      .temporal.api.taskqueue.v1.TaskQueueStats stats = 5;

    • getStatsByPriorityKeyCount

      int getStatsByPriorityKeyCount()
       Task queue stats breakdown by priority key. Only contains actively used priority keys.
 Only set if `report_stats` is set on the request.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
      map<int32, .temporal.api.taskqueue.v1.TaskQueueStats> stats_by_priority_key = 8;

    • containsStatsByPriorityKey

      boolean containsStatsByPriorityKey(int key)
       Task queue stats breakdown by priority key. Only contains actively used priority keys.
 Only set if `report_stats` is set on the request.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
      map<int32, .temporal.api.taskqueue.v1.TaskQueueStats> stats_by_priority_key = 8;

    • getStatsByPriorityKey

      @Deprecated Map<Integer,TaskQueueStats> getStatsByPriorityKey()
      Deprecated.
      Use getStatsByPriorityKeyMap() instead.

    • getStatsByPriorityKeyMap

      Map<Integer,TaskQueueStats> getStatsByPriorityKeyMap()
       Task queue stats breakdown by priority key. Only contains actively used priority keys.
 Only set if `report_stats` is set on the request.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
      map<int32, .temporal.api.taskqueue.v1.TaskQueueStats> stats_by_priority_key = 8;

    • getStatsByPriorityKeyOrDefault

      TaskQueueStats getStatsByPriorityKeyOrDefault(int key, TaskQueueStats defaultValue)
       Task queue stats breakdown by priority key. Only contains actively used priority keys.
 Only set if `report_stats` is set on the request.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
      map<int32, .temporal.api.taskqueue.v1.TaskQueueStats> stats_by_priority_key = 8;

    • getStatsByPriorityKeyOrThrow

      TaskQueueStats getStatsByPriorityKeyOrThrow(int key)
       Task queue stats breakdown by priority key. Only contains actively used priority keys.
 Only set if `report_stats` is set on the request.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
      map<int32, .temporal.api.taskqueue.v1.TaskQueueStats> stats_by_priority_key = 8;

    • hasVersioningInfo

      boolean hasVersioningInfo()
       Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.
 When not present, it means the tasks are routed to Unversioned workers (workers with
 UNVERSIONED or unspecified WorkerVersioningMode.)
 Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion
 and SetWorkerDeploymentRampingVersion on Worker Deployments.
 Note: This information is not relevant to Pinned workflow executions and their activities as
 they are always routed to their Pinned Deployment Version. However, new workflow executions
 are typically not Pinned until they complete their first task (unless they are started with
 a Pinned VersioningOverride or are Child Workflows of a Pinned parent).
      .temporal.api.taskqueue.v1.TaskQueueVersioningInfo versioning_info = 4;
      Returns:
      Whether the versioningInfo field is set.

    • getVersioningInfo

      TaskQueueVersioningInfo getVersioningInfo()
       Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.
 When not present, it means the tasks are routed to Unversioned workers (workers with
 UNVERSIONED or unspecified WorkerVersioningMode.)
 Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion
 and SetWorkerDeploymentRampingVersion on Worker Deployments.
 Note: This information is not relevant to Pinned workflow executions and their activities as
 they are always routed to their Pinned Deployment Version. However, new workflow executions
 are typically not Pinned until they complete their first task (unless they are started with
 a Pinned VersioningOverride or are Child Workflows of a Pinned parent).
      .temporal.api.taskqueue.v1.TaskQueueVersioningInfo versioning_info = 4;
      Returns:
      The versioningInfo.

    • getVersioningInfoOrBuilder

      TaskQueueVersioningInfoOrBuilder getVersioningInfoOrBuilder()
       Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.
 When not present, it means the tasks are routed to Unversioned workers (workers with
 UNVERSIONED or unspecified WorkerVersioningMode.)
 Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion
 and SetWorkerDeploymentRampingVersion on Worker Deployments.
 Note: This information is not relevant to Pinned workflow executions and their activities as
 they are always routed to their Pinned Deployment Version. However, new workflow executions
 are typically not Pinned until they complete their first task (unless they are started with
 a Pinned VersioningOverride or are Child Workflows of a Pinned parent).
      .temporal.api.taskqueue.v1.TaskQueueVersioningInfo versioning_info = 4;

    • hasConfig

      boolean hasConfig()
       Only populated if report_task_queue_config is set to true.
      .temporal.api.taskqueue.v1.TaskQueueConfig config = 6;
      Returns:
      Whether the config field is set.

    • getConfig

      TaskQueueConfig getConfig()
       Only populated if report_task_queue_config is set to true.
      .temporal.api.taskqueue.v1.TaskQueueConfig config = 6;
      Returns:
      The config.

    • getConfigOrBuilder

      TaskQueueConfigOrBuilder getConfigOrBuilder()
       Only populated if report_task_queue_config is set to true.
      .temporal.api.taskqueue.v1.TaskQueueConfig config = 6;

    • hasEffectiveRateLimit

      boolean hasEffectiveRateLimit()
      .temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit effective_rate_limit = 7;
      Returns:
      Whether the effectiveRateLimit field is set.

    • getEffectiveRateLimit

      DescribeTaskQueueResponse.EffectiveRateLimit getEffectiveRateLimit()
      .temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit effective_rate_limit = 7;
      Returns:
      The effectiveRateLimit.

    • getEffectiveRateLimitOrBuilder

      DescribeTaskQueueResponse.EffectiveRateLimitOrBuilder getEffectiveRateLimitOrBuilder()
      .temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit effective_rate_limit = 7;

    • hasTaskQueueStatus

      @Deprecated boolean hasTaskQueueStatus()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueResponse.task_queue_status is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1297
       Deprecated.
 Status of the task queue. Only populated when `include_task_queue_status` is set to true in the request.
      .temporal.api.taskqueue.v1.TaskQueueStatus task_queue_status = 2 [deprecated = true];
      Returns:
      Whether the taskQueueStatus field is set.

    • getTaskQueueStatus

      @Deprecated TaskQueueStatus getTaskQueueStatus()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueResponse.task_queue_status is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1297
       Deprecated.
 Status of the task queue. Only populated when `include_task_queue_status` is set to true in the request.
      .temporal.api.taskqueue.v1.TaskQueueStatus task_queue_status = 2 [deprecated = true];
      Returns:
      The taskQueueStatus.

    • getTaskQueueStatusOrBuilder

      @Deprecated TaskQueueStatusOrBuilder getTaskQueueStatusOrBuilder()
      Deprecated.
       Deprecated.
 Status of the task queue. Only populated when `include_task_queue_status` is set to true in the request.
      .temporal.api.taskqueue.v1.TaskQueueStatus task_queue_status = 2 [deprecated = true];

    • getVersionsInfoCount

      @Deprecated int getVersionsInfoCount()
      Deprecated.
       Deprecated.
 Only returned in ENHANCED mode.
 This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
      map<string, .temporal.api.taskqueue.v1.TaskQueueVersionInfo> versions_info = 3 [deprecated = true];

    • containsVersionsInfo

      @Deprecated boolean containsVersionsInfo(String key)
      Deprecated.
       Deprecated.
 Only returned in ENHANCED mode.
 This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
      map<string, .temporal.api.taskqueue.v1.TaskQueueVersionInfo> versions_info = 3 [deprecated = true];

    • getVersionsInfo

      @Deprecated Map<String,TaskQueueVersionInfo> getVersionsInfo()
      Deprecated.
      Use getVersionsInfoMap() instead.

    • getVersionsInfoMap

      @Deprecated Map<String,TaskQueueVersionInfo> getVersionsInfoMap()
      Deprecated.
       Deprecated.
 Only returned in ENHANCED mode.
 This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
      map<string, .temporal.api.taskqueue.v1.TaskQueueVersionInfo> versions_info = 3 [deprecated = true];

    • getVersionsInfoOrDefault

      @Deprecated TaskQueueVersionInfo getVersionsInfoOrDefault(String key, TaskQueueVersionInfo defaultValue)
      Deprecated.
       Deprecated.
 Only returned in ENHANCED mode.
 This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
      map<string, .temporal.api.taskqueue.v1.TaskQueueVersionInfo> versions_info = 3 [deprecated = true];

    • getVersionsInfoOrThrow

      @Deprecated TaskQueueVersionInfo getVersionsInfoOrThrow(String key)
      Deprecated.
       Deprecated.
 Only returned in ENHANCED mode.
 This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
      map<string, .temporal.api.taskqueue.v1.TaskQueueVersionInfo> versions_info = 3 [deprecated = true];