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 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 `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 `ENHANCED` mode.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
        Returns:
        The taskQueue.

      • getTaskQueueOrBuilder

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

      • getTaskQueueTypeValue

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

      • getTaskQueueType

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

      • getIncludeTaskQueueStatus

        boolean getIncludeTaskQueueStatus()
         Deprecated. Ignored in `ENHANCED` mode.
        bool include_task_queue_status = 4;
        Returns:
        The includeTaskQueueStatus.

      • getApiModeValue

        int getApiModeValue()
         All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.
        .temporal.api.enums.v1.DescribeTaskQueueMode api_mode = 5;
        Returns:
        The enum numeric value on the wire for apiMode.

      • getApiMode

        DescribeTaskQueueMode getApiMode()
         All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.
        .temporal.api.enums.v1.DescribeTaskQueueMode api_mode = 5;
        Returns:
        The apiMode.

      • hasVersions

        boolean hasVersions()
         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;
        Returns:
        Whether the versions field is set.

      • getVersions

        TaskQueueVersionSelection getVersions()
         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;
        Returns:
        The versions.

      • getVersionsOrBuilder

        TaskQueueVersionSelectionOrBuilder getVersionsOrBuilder()
         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;

      • getTaskQueueTypesList

        java.util.List<TaskQueueType> getTaskQueueTypesList()
         Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7;
        Returns:
        A list containing the taskQueueTypes.

      • getTaskQueueTypesCount

        int getTaskQueueTypesCount()
         Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7;
        Returns:
        The count of taskQueueTypes.

      • getTaskQueueTypes

        TaskQueueType getTaskQueueTypes​(int index)
         Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The taskQueueTypes at the given index.

      • getTaskQueueTypesValueList

        java.util.List<java.lang.Integer> getTaskQueueTypesValueList()
         Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7;
        Returns:
        A list containing the enum numeric values on the wire for taskQueueTypes.

      • getTaskQueueTypesValue

        int getTaskQueueTypesValue​(int index)
         Task queue types to report info about. If not specified, all types are considered.
        repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of taskQueueTypes at the given index.

      • getReportPollers

        boolean getReportPollers()
         Report backlog info for the requested task queue types and versions
 bool report_backlog_info = 8;
 Report list of pollers for requested task queue types and versions
        bool report_pollers = 9;
        Returns:
        The reportPollers.

      • getReportTaskReachability

        boolean getReportTaskReachability()
         Report task reachability for the requested versions and all task types (task reachability is not reported
 per task type).
        bool report_task_reachability = 10;
        Returns:
        The reportTaskReachability.