Package io.temporal.api.workflowservice.v1

Class GetWorkerTaskReachabilityRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GetWorkerTaskReachabilityRequestOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:GetWorkerTaskReachabilityRequest.java.pb.meta")
public final class GetWorkerTaskReachabilityRequest
extends com.google.protobuf.GeneratedMessageV3
implements GetWorkerTaskReachabilityRequestOrBuilder
     [cleanup-wv-pre-release]
 Deprecated. Use `DescribeTaskQueue`.
    Protobuf type temporal.api.workflowservice.v1.GetWorkerTaskReachabilityRequest
    See Also:
    Serialized Form

    • 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

      • getBuildIdsList

        public com.google.protobuf.ProtocolStringList getBuildIdsList()
         Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker.
 The number of build ids that can be queried in a single API call is limited.
 Open source users can adjust this limit by setting the server's dynamic config value for
 `limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.
        repeated string build_ids = 2;
        Specified by:
        getBuildIdsList in interface GetWorkerTaskReachabilityRequestOrBuilder
        Returns:
        A list containing the buildIds.

      • getBuildIdsCount

        public int getBuildIdsCount()
         Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker.
 The number of build ids that can be queried in a single API call is limited.
 Open source users can adjust this limit by setting the server's dynamic config value for
 `limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.
        repeated string build_ids = 2;
        Specified by:
        getBuildIdsCount in interface GetWorkerTaskReachabilityRequestOrBuilder
        Returns:
        The count of buildIds.

      • getBuildIds

        public java.lang.String getBuildIds​(int index)
         Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker.
 The number of build ids that can be queried in a single API call is limited.
 Open source users can adjust this limit by setting the server's dynamic config value for
 `limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.
        repeated string build_ids = 2;
        Specified by:
        getBuildIds in interface GetWorkerTaskReachabilityRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The buildIds at the given index.

      • getBuildIdsBytes

        public com.google.protobuf.ByteString getBuildIdsBytes​(int index)
         Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker.
 The number of build ids that can be queried in a single API call is limited.
 Open source users can adjust this limit by setting the server's dynamic config value for
 `limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.
        repeated string build_ids = 2;
        Specified by:
        getBuildIdsBytes in interface GetWorkerTaskReachabilityRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the buildIds at the given index.

      • getTaskQueuesList

        public com.google.protobuf.ProtocolStringList getTaskQueuesList()
         Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given
 build ids in the namespace.
 Must specify at least one task queue if querying for an unversioned worker.
 The number of task queues that the server will fetch reachability information for is limited.
 See the `GetWorkerTaskReachabilityResponse` documentation for more information.
        repeated string task_queues = 3;
        Specified by:
        getTaskQueuesList in interface GetWorkerTaskReachabilityRequestOrBuilder
        Returns:
        A list containing the taskQueues.

      • getTaskQueuesCount

        public int getTaskQueuesCount()
         Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given
 build ids in the namespace.
 Must specify at least one task queue if querying for an unversioned worker.
 The number of task queues that the server will fetch reachability information for is limited.
 See the `GetWorkerTaskReachabilityResponse` documentation for more information.
        repeated string task_queues = 3;
        Specified by:
        getTaskQueuesCount in interface GetWorkerTaskReachabilityRequestOrBuilder
        Returns:
        The count of taskQueues.

      • getTaskQueues

        public java.lang.String getTaskQueues​(int index)
         Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given
 build ids in the namespace.
 Must specify at least one task queue if querying for an unversioned worker.
 The number of task queues that the server will fetch reachability information for is limited.
 See the `GetWorkerTaskReachabilityResponse` documentation for more information.
        repeated string task_queues = 3;
        Specified by:
        getTaskQueues in interface GetWorkerTaskReachabilityRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The taskQueues at the given index.

      • getTaskQueuesBytes

        public com.google.protobuf.ByteString getTaskQueuesBytes​(int index)
         Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given
 build ids in the namespace.
 Must specify at least one task queue if querying for an unversioned worker.
 The number of task queues that the server will fetch reachability information for is limited.
 See the `GetWorkerTaskReachabilityResponse` documentation for more information.
        repeated string task_queues = 3;
        Specified by:
        getTaskQueuesBytes in interface GetWorkerTaskReachabilityRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the taskQueues at the given index.

      • getReachabilityValue

        public int getReachabilityValue()
         Type of reachability to query for.
 `TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response.
 Use `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows.
 Otherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left
 unspecified.
 See the TaskReachability docstring for information about each enum variant.
        .temporal.api.enums.v1.TaskReachability reachability = 4;
        Specified by:
        getReachabilityValue in interface GetWorkerTaskReachabilityRequestOrBuilder
        Returns:
        The enum numeric value on the wire for reachability.

      • getReachability

        public TaskReachability getReachability()
         Type of reachability to query for.
 `TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response.
 Use `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows.
 Otherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left
 unspecified.
 See the TaskReachability docstring for information about each enum variant.
        .temporal.api.enums.v1.TaskReachability reachability = 4;
        Specified by:
        getReachability in interface GetWorkerTaskReachabilityRequestOrBuilder
        Returns:
        The reachability.

      • 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 GetWorkerTaskReachabilityRequest parseFrom​(java.nio.ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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