Package io.temporal.api.workflowservice.v1

Interface DescribeTaskQueueRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      DescribeTaskQueueMode getApiMode()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.api_mode is deprecated.
      int getApiModeValue()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.api_mode is deprecated.
      boolean getIncludeTaskQueueStatus()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.include_task_queue_status is deprecated.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      boolean getReportConfig()
      Report Task Queue Config
      boolean getReportPollers()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.report_pollers is deprecated.
      boolean getReportStats()
      Report stats for the requested task queue type(s).
      boolean getReportTaskReachability()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.report_task_reachability is deprecated.
      TaskQueue getTaskQueue()
      Sticky queues are not supported in deprecated ENHANCED mode.
      TaskQueueOrBuilder getTaskQueueOrBuilder()
      Sticky queues are not supported in deprecated ENHANCED mode.
      TaskQueueType getTaskQueueType()
      If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
      TaskQueueType getTaskQueueTypes​(int index)
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated.
      int getTaskQueueTypesCount()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated.
      java.util.List<TaskQueueType> getTaskQueueTypesList()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated.
      int getTaskQueueTypesValue​(int index)
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated.
      java.util.List<java.lang.Integer> getTaskQueueTypesValueList()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated.
      int getTaskQueueTypeValue()
      If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
      TaskQueueVersionSelection getVersions()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.versions is deprecated.
      TaskQueueVersionSelectionOrBuilder getVersionsOrBuilder()
      Deprecated.
      boolean hasTaskQueue()
      Sticky queues are not supported in deprecated ENHANCED mode.
      boolean hasVersions()
      Deprecated.
      temporal.api.workflowservice.v1.DescribeTaskQueueRequest.versions is deprecated.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • hasTaskQueue

        boolean hasTaskQueue()
         Sticky queues are not supported in deprecated ENHANCED mode.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
        Returns:
        Whether the taskQueue field is set.

      • getTaskQueue

        TaskQueue getTaskQueue()
         Sticky queues are not supported in deprecated ENHANCED mode.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
        Returns:
        The taskQueue.

      • getTaskQueueOrBuilder

        TaskQueueOrBuilder getTaskQueueOrBuilder()
         Sticky queues are not supported in deprecated ENHANCED mode.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 2;

      • getTaskQueueTypeValue

        int getTaskQueueTypeValue()
         If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
 Only supported in default mode (use `task_queue_types` in ENHANCED mode instead).
        .temporal.api.enums.v1.TaskQueueType task_queue_type = 3;
        Returns:
        The enum numeric value on the wire for taskQueueType.

      • getTaskQueueType

        TaskQueueType getTaskQueueType()
         If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
 Only supported in default mode (use `task_queue_types` in ENHANCED mode instead).
        .temporal.api.enums.v1.TaskQueueType task_queue_type = 3;
        Returns:
        The taskQueueType.

      • getReportStats

        boolean getReportStats()
         Report stats for the requested task queue type(s).
        bool report_stats = 8;
        Returns:
        The reportStats.

      • getReportConfig

        boolean getReportConfig()
         Report Task Queue Config
        bool report_config = 11;
        Returns:
        The reportConfig.

      • getIncludeTaskQueueStatus

        @Deprecated
boolean getIncludeTaskQueueStatus()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.include_task_queue_status is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1066
         Deprecated, use `report_stats` instead.
 If true, the task queue status will be included in the response.
        bool include_task_queue_status = 4 [deprecated = true];
        Returns:
        The includeTaskQueueStatus.

      • getApiModeValue

        @Deprecated
int getApiModeValue()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.api_mode is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1071
         Deprecated. ENHANCED mode is also being deprecated.
 Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.
 Consult the documentation for each field to understand which mode it is supported in.
        .temporal.api.enums.v1.DescribeTaskQueueMode api_mode = 5 [deprecated = true];
        Returns:
        The enum numeric value on the wire for apiMode.

      • getApiMode

        @Deprecated
DescribeTaskQueueMode getApiMode()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.api_mode is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1071
         Deprecated. ENHANCED mode is also being deprecated.
 Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.
 Consult the documentation for each field to understand which mode it is supported in.
        .temporal.api.enums.v1.DescribeTaskQueueMode api_mode = 5 [deprecated = true];
        Returns:
        The apiMode.

      • hasVersions

        @Deprecated
boolean hasVersions()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.versions is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1078
         Deprecated (as part of the ENHANCED mode deprecation).
 Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one
 mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the
 unversioned queue will be returned.
 (-- api-linter: core::0140::prepositions --)
        .temporal.api.taskqueue.v1.TaskQueueVersionSelection versions = 6 [deprecated = true];
        Returns:
        Whether the versions field is set.

      • getVersions

        @Deprecated
TaskQueueVersionSelection getVersions()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.versions is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1078
         Deprecated (as part of the ENHANCED mode deprecation).
 Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one
 mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the
 unversioned queue will be returned.
 (-- api-linter: core::0140::prepositions --)
        .temporal.api.taskqueue.v1.TaskQueueVersionSelection versions = 6 [deprecated = true];
        Returns:
        The versions.

      • getVersionsOrBuilder

        @Deprecated
TaskQueueVersionSelectionOrBuilder getVersionsOrBuilder()
        Deprecated.
         Deprecated (as part of the ENHANCED mode deprecation).
 Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one
 mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the
 unversioned queue will be returned.
 (-- api-linter: core::0140::prepositions --)
        .temporal.api.taskqueue.v1.TaskQueueVersionSelection versions = 6 [deprecated = true];

      • getTaskQueueTypesList

        @Deprecated
java.util.List<TaskQueueType> getTaskQueueTypesList()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1082
         Deprecated (as part of the ENHANCED mode deprecation).
 Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7 [deprecated = true];
        Returns:
        A list containing the taskQueueTypes.

      • getTaskQueueTypesCount

        @Deprecated
int getTaskQueueTypesCount()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1082
         Deprecated (as part of the ENHANCED mode deprecation).
 Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7 [deprecated = true];
        Returns:
        The count of taskQueueTypes.

      • getTaskQueueTypes

        @Deprecated
TaskQueueType getTaskQueueTypes​(int index)
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1082
         Deprecated (as part of the ENHANCED mode deprecation).
 Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7 [deprecated = true];
        Parameters:
        index - The index of the element to return.
        Returns:
        The taskQueueTypes at the given index.

      • getTaskQueueTypesValueList

        @Deprecated
java.util.List<java.lang.Integer> getTaskQueueTypesValueList()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1082
         Deprecated (as part of the ENHANCED mode deprecation).
 Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7 [deprecated = true];
        Returns:
        A list containing the enum numeric values on the wire for taskQueueTypes.

      • getTaskQueueTypesValue

        @Deprecated
int getTaskQueueTypesValue​(int index)
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.task_queue_types is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1082
         Deprecated (as part of the ENHANCED mode deprecation).
 Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7 [deprecated = true];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of taskQueueTypes at the given index.

      • getReportPollers

        @Deprecated
boolean getReportPollers()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.report_pollers is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1086
         Deprecated (as part of the ENHANCED mode deprecation).
 Report list of pollers for requested task queue types and versions.
        bool report_pollers = 9 [deprecated = true];
        Returns:
        The reportPollers.

      • getReportTaskReachability

        @Deprecated
boolean getReportTaskReachability()
        Deprecated.
        temporal.api.workflowservice.v1.DescribeTaskQueueRequest.report_task_reachability is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=1091
         Deprecated (as part of the ENHANCED mode deprecation).
 Report task reachability for the requested versions and all task types (task reachability is not reported
 per task type).
        bool report_task_reachability = 10 [deprecated = true];
        Returns:
        The reportTaskReachability.