Package io.temporal.api.workflowservice.v1

Class DescribeTaskQueueRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DescribeTaskQueueRequestOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:DescribeTaskQueueRequest.java.pb.meta")
public final class DescribeTaskQueueRequest
extends com.google.protobuf.GeneratedMessageV3
implements DescribeTaskQueueRequestOrBuilder
     (-- api-linter: core::0203::optional=disabled
     aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)
    Protobuf type temporal.api.workflowservice.v1.DescribeTaskQueueRequest
    See Also:
    Serialized Form

    • Field Detail

      • TASK_QUEUE_FIELD_NUMBER

        public static final int TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_TYPE_FIELD_NUMBER

        public static final int TASK_QUEUE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_STATS_FIELD_NUMBER

        public static final int REPORT_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_CONFIG_FIELD_NUMBER

        public static final int REPORT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_TASK_QUEUE_STATUS_FIELD_NUMBER

        public static final int INCLUDE_TASK_QUEUE_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_TYPES_FIELD_NUMBER

        public static final int TASK_QUEUE_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_POLLERS_FIELD_NUMBER

        public static final int REPORT_POLLERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_TASK_REACHABILITY_FIELD_NUMBER

        public static final int REPORT_TASK_REACHABILITY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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()

      • internalGetFieldAccessorTable

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

      • hasTaskQueue

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

      • getTaskQueueTypeValue

        public 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;
        Specified by:
        getTaskQueueTypeValue in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The enum numeric value on the wire for taskQueueType.

      • getTaskQueueType

        public 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;
        Specified by:
        getTaskQueueType in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The taskQueueType.

      • getIncludeTaskQueueStatus

        @Deprecated
public 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];
        Specified by:
        getIncludeTaskQueueStatus in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The includeTaskQueueStatus.

      • getApiModeValue

        @Deprecated
public 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];
        Specified by:
        getApiModeValue in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The enum numeric value on the wire for apiMode.

      • getApiMode

        @Deprecated
public 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];
        Specified by:
        getApiMode in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The apiMode.

      • hasVersions

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

      • getVersions

        @Deprecated
public 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];
        Specified by:
        getVersions in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The versions.

      • getVersionsOrBuilder

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

      • getTaskQueueTypesList

        @Deprecated
public 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];
        Specified by:
        getTaskQueueTypesList in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        A list containing the taskQueueTypes.

      • getTaskQueueTypesCount

        @Deprecated
public 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];
        Specified by:
        getTaskQueueTypesCount in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The count of taskQueueTypes.

      • getTaskQueueTypes

        @Deprecated
public 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];
        Specified by:
        getTaskQueueTypes in interface DescribeTaskQueueRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The taskQueueTypes at the given index.

      • getTaskQueueTypesValueList

        @Deprecated
public 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];
        Specified by:
        getTaskQueueTypesValueList in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for taskQueueTypes.

      • getTaskQueueTypesValue

        @Deprecated
public 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];
        Specified by:
        getTaskQueueTypesValue in interface DescribeTaskQueueRequestOrBuilder
        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
public 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];
        Specified by:
        getReportPollers in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The reportPollers.

      • getReportTaskReachability

        @Deprecated
public 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];
        Specified by:
        getReportTaskReachability in interface DescribeTaskQueueRequestOrBuilder
        Returns:
        The reportTaskReachability.

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

      • parseFrom

        public static DescribeTaskQueueRequest parseFrom​(java.nio.ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static DescribeTaskQueueRequest parseFrom​(java.io.InputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static DescribeTaskQueueRequest parseFrom​(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DescribeTaskQueueRequest parseDelimitedFrom​(java.io.InputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DescribeTaskQueueRequest parseDelimitedFrom​(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static DescribeTaskQueueRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static DescribeTaskQueueRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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