Package io.temporal.api.workflowservice.v1

Interface GetWorkerTaskReachabilityRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBuildIds​(int index)
      Build ids to retrieve reachability for.
      com.google.protobuf.ByteString getBuildIdsBytes​(int index)
      Build ids to retrieve reachability for.
      int getBuildIdsCount()
      Build ids to retrieve reachability for.
      java.util.List<java.lang.String> getBuildIdsList()
      Build ids to retrieve reachability for.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      TaskReachability getReachability()
      Type of reachability to query for.
      int getReachabilityValue()
      Type of reachability to query for.
      java.lang.String getTaskQueues​(int index)
      Task queues to retrieve reachability for.
      com.google.protobuf.ByteString getTaskQueuesBytes​(int index)
      Task queues to retrieve reachability for.
      int getTaskQueuesCount()
      Task queues to retrieve reachability for.
      java.util.List<java.lang.String> getTaskQueuesList()
      Task queues to retrieve reachability for.

      • 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.

      • getBuildIdsList

        java.util.List<java.lang.String> 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;
        Returns:
        A list containing the buildIds.

      • getBuildIdsCount

        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;
        Returns:
        The count of buildIds.

      • getBuildIds

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The buildIds at the given index.

      • getBuildIdsBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the buildIds at the given index.

      • getTaskQueuesList

        java.util.List<java.lang.String> 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;
        Returns:
        A list containing the taskQueues.

      • getTaskQueuesCount

        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;
        Returns:
        The count of taskQueues.

      • getTaskQueues

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The taskQueues at the given index.

      • getTaskQueuesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the taskQueues at the given index.

      • getReachabilityValue

        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;
        Returns:
        The enum numeric value on the wire for reachability.

      • getReachability

        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;
        Returns:
        The reachability.