Class DescribeTaskQueueResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.workflowservice.v1.DescribeTaskQueueResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DescribeTaskQueueResponseOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:DescribeTaskQueueResponse.java.pb.meta") public final class DescribeTaskQueueResponse extends com.google.protobuf.GeneratedMessageV3 implements DescribeTaskQueueResponseOrBuilder
Protobuf type temporal.api.workflowservice.v1.DescribeTaskQueueResponse
See Also:

  • Field Details

    • POLLERS_FIELD_NUMBER

      public static final int POLLERS_FIELD_NUMBER
      See Also:

    • STATS_FIELD_NUMBER

      public static final int STATS_FIELD_NUMBER
      See Also:

    • STATS_BY_PRIORITY_KEY_FIELD_NUMBER

      public static final int STATS_BY_PRIORITY_KEY_FIELD_NUMBER
      See Also:

    • VERSIONING_INFO_FIELD_NUMBER

      public static final int VERSIONING_INFO_FIELD_NUMBER
      See Also:

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • EFFECTIVE_RATE_LIMIT_FIELD_NUMBER

      public static final int EFFECTIVE_RATE_LIMIT_FIELD_NUMBER
      See Also:

    • TASK_QUEUE_STATUS_FIELD_NUMBER

      public static final int TASK_QUEUE_STATUS_FIELD_NUMBER
      See Also:

    • VERSIONS_INFO_FIELD_NUMBER

      public static final int VERSIONS_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getPollersList

      public List<PollerInfo> getPollersList()
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;
      Specified by:
      getPollersList in interface DescribeTaskQueueResponseOrBuilder

    • getPollersOrBuilderList

      public List<? extends PollerInfoOrBuilder> getPollersOrBuilderList()
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;
      Specified by:
      getPollersOrBuilderList in interface DescribeTaskQueueResponseOrBuilder

    • getPollersCount

      public int getPollersCount()
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;
      Specified by:
      getPollersCount in interface DescribeTaskQueueResponseOrBuilder

    • getPollers

      public PollerInfo getPollers(int index)
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;
      Specified by:
      getPollers in interface DescribeTaskQueueResponseOrBuilder

    • getPollersOrBuilder

      public PollerInfoOrBuilder getPollersOrBuilder(int index)
      repeated .temporal.api.taskqueue.v1.PollerInfo pollers = 1;
      Specified by:
      getPollersOrBuilder in interface DescribeTaskQueueResponseOrBuilder

    • hasStats

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

    • getStats

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

    • getStatsOrBuilder

      public TaskQueueStatsOrBuilder getStatsOrBuilder()
       Statistics for the task queue.
 Only set if `report_stats` is set on the request.
      .temporal.api.taskqueue.v1.TaskQueueStats stats = 5;
      Specified by:
      getStatsOrBuilder in interface DescribeTaskQueueResponseOrBuilder

    • getStatsByPriorityKeyCount

      public int getStatsByPriorityKeyCount()
      Description copied from interface: DescribeTaskQueueResponseOrBuilder
       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;
      Specified by:
      getStatsByPriorityKeyCount in interface DescribeTaskQueueResponseOrBuilder

    • containsStatsByPriorityKey

      public 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;
      Specified by:
      containsStatsByPriorityKey in interface DescribeTaskQueueResponseOrBuilder

    • getStatsByPriorityKey

      @Deprecated public Map<Integer,TaskQueueStats> getStatsByPriorityKey()
      Deprecated.
      Use getStatsByPriorityKeyMap() instead.
      Specified by:
      getStatsByPriorityKey in interface DescribeTaskQueueResponseOrBuilder

    • getStatsByPriorityKeyMap

      public 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;
      Specified by:
      getStatsByPriorityKeyMap in interface DescribeTaskQueueResponseOrBuilder

    • getStatsByPriorityKeyOrDefault

      public 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;
      Specified by:
      getStatsByPriorityKeyOrDefault in interface DescribeTaskQueueResponseOrBuilder

    • getStatsByPriorityKeyOrThrow

      public 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;
      Specified by:
      getStatsByPriorityKeyOrThrow in interface DescribeTaskQueueResponseOrBuilder

    • hasVersioningInfo

      public 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;
      Specified by:
      hasVersioningInfo in interface DescribeTaskQueueResponseOrBuilder
      Returns:
      Whether the versioningInfo field is set.

    • getVersioningInfo

      public 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;
      Specified by:
      getVersioningInfo in interface DescribeTaskQueueResponseOrBuilder
      Returns:
      The versioningInfo.

    • getVersioningInfoOrBuilder

      public 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;
      Specified by:
      getVersioningInfoOrBuilder in interface DescribeTaskQueueResponseOrBuilder

    • hasConfig

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

    • getConfig

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

    • getConfigOrBuilder

      public TaskQueueConfigOrBuilder getConfigOrBuilder()
       Only populated if report_task_queue_config is set to true.
      .temporal.api.taskqueue.v1.TaskQueueConfig config = 6;
      Specified by:
      getConfigOrBuilder in interface DescribeTaskQueueResponseOrBuilder

    • hasEffectiveRateLimit

      public boolean hasEffectiveRateLimit()
      .temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit effective_rate_limit = 7;
      Specified by:
      hasEffectiveRateLimit in interface DescribeTaskQueueResponseOrBuilder
      Returns:
      Whether the effectiveRateLimit field is set.

    • getEffectiveRateLimit

      public DescribeTaskQueueResponse.EffectiveRateLimit getEffectiveRateLimit()
      .temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit effective_rate_limit = 7;
      Specified by:
      getEffectiveRateLimit in interface DescribeTaskQueueResponseOrBuilder
      Returns:
      The effectiveRateLimit.

    • getEffectiveRateLimitOrBuilder

      public DescribeTaskQueueResponse.EffectiveRateLimitOrBuilder getEffectiveRateLimitOrBuilder()
      .temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit effective_rate_limit = 7;
      Specified by:
      getEffectiveRateLimitOrBuilder in interface DescribeTaskQueueResponseOrBuilder

    • hasTaskQueueStatus

      @Deprecated public 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];
      Specified by:
      hasTaskQueueStatus in interface DescribeTaskQueueResponseOrBuilder
      Returns:
      Whether the taskQueueStatus field is set.

    • getTaskQueueStatus

      @Deprecated public 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];
      Specified by:
      getTaskQueueStatus in interface DescribeTaskQueueResponseOrBuilder
      Returns:
      The taskQueueStatus.

    • getTaskQueueStatusOrBuilder

      @Deprecated public 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];
      Specified by:
      getTaskQueueStatusOrBuilder in interface DescribeTaskQueueResponseOrBuilder

    • getVersionsInfoCount

      @Deprecated public int getVersionsInfoCount()
      Deprecated.
      Description copied from interface: DescribeTaskQueueResponseOrBuilder
       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];
      Specified by:
      getVersionsInfoCount in interface DescribeTaskQueueResponseOrBuilder

    • containsVersionsInfo

      @Deprecated public 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];
      Specified by:
      containsVersionsInfo in interface DescribeTaskQueueResponseOrBuilder

    • getVersionsInfo

      @Deprecated public Map<String,TaskQueueVersionInfo> getVersionsInfo()
      Deprecated.
      Use getVersionsInfoMap() instead.
      Specified by:
      getVersionsInfo in interface DescribeTaskQueueResponseOrBuilder

    • getVersionsInfoMap

      @Deprecated public 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];
      Specified by:
      getVersionsInfoMap in interface DescribeTaskQueueResponseOrBuilder

    • getVersionsInfoOrDefault

      @Deprecated public 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];
      Specified by:
      getVersionsInfoOrDefault in interface DescribeTaskQueueResponseOrBuilder

    • getVersionsInfoOrThrow

      @Deprecated public 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];
      Specified by:
      getVersionsInfoOrThrow in interface DescribeTaskQueueResponseOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 DescribeTaskQueueResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescribeTaskQueueResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DescribeTaskQueueResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescribeTaskQueueResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescribeTaskQueueResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescribeTaskQueueResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescribeTaskQueueResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescribeTaskQueueResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static DescribeTaskQueueResponse.Builder newBuilder()

    • newBuilder

      public static DescribeTaskQueueResponse.Builder newBuilder(DescribeTaskQueueResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DescribeTaskQueueResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DescribeTaskQueueResponse> parser()

    • getParserForType

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