Interface ShutdownWorkerRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIdentity()
    string identity = 3;
    com.google.protobuf.ByteString
    getIdentityBytes()
    string identity = 3;
    String
    getNamespace()
    string namespace = 1;
    com.google.protobuf.ByteString
    getNamespaceBytes()
    string namespace = 1;
    String
    getReason()
    string reason = 4;
    com.google.protobuf.ByteString
    getReasonBytes()
    string reason = 4;
    String
    getStickyTaskQueue()
    sticky_task_queue may not always be populated.
    com.google.protobuf.ByteString
    getStickyTaskQueueBytes()
    sticky_task_queue may not always be populated.
    String
    getTaskQueue()
    Task queue name the worker is polling on.
    com.google.protobuf.ByteString
    getTaskQueueBytes()
    Task queue name the worker is polling on.
    TaskQueueType
    getTaskQueueTypes(int index)
    Task queue types that help server cancel outstanding poll RPC calls from SDK.
    int
    getTaskQueueTypesCount()
    Task queue types that help server cancel outstanding poll RPC calls from SDK.
    List<TaskQueueType>
    getTaskQueueTypesList()
    Task queue types that help server cancel outstanding poll RPC calls from SDK.
    int
    getTaskQueueTypesValue(int index)
    Task queue types that help server cancel outstanding poll RPC calls from SDK.
    List<Integer>
    getTaskQueueTypesValueList()
    Task queue types that help server cancel outstanding poll RPC calls from SDK.
    WorkerHeartbeat
    getWorkerHeartbeat()
    .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;
    WorkerHeartbeatOrBuilder
    getWorkerHeartbeatOrBuilder()
    .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;
    String
    getWorkerInstanceKey()
    Technically this is also sent in the WorkerHeartbeat, but since worker heartbeating can be turned off, this needs to be a separate, top-level field.
    com.google.protobuf.ByteString
    getWorkerInstanceKeyBytes()
    Technically this is also sent in the WorkerHeartbeat, but since worker heartbeating can be turned off, this needs to be a separate, top-level field.
    boolean
    hasWorkerHeartbeat()
    .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;

    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 Details

    • getNamespace

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

    • getNamespaceBytes

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

    • getStickyTaskQueue

      String getStickyTaskQueue()
       sticky_task_queue may not always be populated. We want to ensure all workers
 send a shutdown request to update worker state for heartbeating, as well
 as cancel pending poll calls early, instead of waiting for timeouts.
      string sticky_task_queue = 2;
      Returns:
      The stickyTaskQueue.

    • getStickyTaskQueueBytes

      com.google.protobuf.ByteString getStickyTaskQueueBytes()
       sticky_task_queue may not always be populated. We want to ensure all workers
 send a shutdown request to update worker state for heartbeating, as well
 as cancel pending poll calls early, instead of waiting for timeouts.
      string sticky_task_queue = 2;
      Returns:
      The bytes for stickyTaskQueue.

    • getIdentity

      String getIdentity()
      string identity = 3;
      Returns:
      The identity.

    • getIdentityBytes

      com.google.protobuf.ByteString getIdentityBytes()
      string identity = 3;
      Returns:
      The bytes for identity.

    • getReason

      String getReason()
      string reason = 4;
      Returns:
      The reason.

    • getReasonBytes

      com.google.protobuf.ByteString getReasonBytes()
      string reason = 4;
      Returns:
      The bytes for reason.

    • hasWorkerHeartbeat

      boolean hasWorkerHeartbeat()
      .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;
      Returns:
      Whether the workerHeartbeat field is set.

    • getWorkerHeartbeat

      WorkerHeartbeat getWorkerHeartbeat()
      .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;
      Returns:
      The workerHeartbeat.

    • getWorkerHeartbeatOrBuilder

      WorkerHeartbeatOrBuilder getWorkerHeartbeatOrBuilder()
      .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;

    • getWorkerInstanceKey

      String getWorkerInstanceKey()
       Technically this is also sent in the WorkerHeartbeat, but
 since worker heartbeating can be turned off, this needs
 to be a separate, top-level field.
      string worker_instance_key = 6;
      Returns:
      The workerInstanceKey.

    • getWorkerInstanceKeyBytes

      com.google.protobuf.ByteString getWorkerInstanceKeyBytes()
       Technically this is also sent in the WorkerHeartbeat, but
 since worker heartbeating can be turned off, this needs
 to be a separate, top-level field.
      string worker_instance_key = 6;
      Returns:
      The bytes for workerInstanceKey.

    • getTaskQueue

      String getTaskQueue()
       Task queue name the worker is polling on. This allows server to cancel
 all outstanding poll RPC calls from SDK. This avoids a race condition that
 can lead to tasks being lost.
      string task_queue = 7;
      Returns:
      The taskQueue.

    • getTaskQueueBytes

      com.google.protobuf.ByteString getTaskQueueBytes()
       Task queue name the worker is polling on. This allows server to cancel
 all outstanding poll RPC calls from SDK. This avoids a race condition that
 can lead to tasks being lost.
      string task_queue = 7;
      Returns:
      The bytes for taskQueue.

    • getTaskQueueTypesList

      List<TaskQueueType> getTaskQueueTypesList()
       Task queue types that help server cancel outstanding poll RPC
 calls from SDK. This avoids a race condition that can lead to tasks being lost.
      repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 8;
      Returns:
      A list containing the taskQueueTypes.

    • getTaskQueueTypesCount

      int getTaskQueueTypesCount()
       Task queue types that help server cancel outstanding poll RPC
 calls from SDK. This avoids a race condition that can lead to tasks being lost.
      repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 8;
      Returns:
      The count of taskQueueTypes.

    • getTaskQueueTypes

      TaskQueueType getTaskQueueTypes(int index)
       Task queue types that help server cancel outstanding poll RPC
 calls from SDK. This avoids a race condition that can lead to tasks being lost.
      repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 8;
      Parameters:
      index - The index of the element to return.
      Returns:
      The taskQueueTypes at the given index.

    • getTaskQueueTypesValueList

      List<Integer> getTaskQueueTypesValueList()
       Task queue types that help server cancel outstanding poll RPC
 calls from SDK. This avoids a race condition that can lead to tasks being lost.
      repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 8;
      Returns:
      A list containing the enum numeric values on the wire for taskQueueTypes.

    • getTaskQueueTypesValue

      int getTaskQueueTypesValue(int index)
       Task queue types that help server cancel outstanding poll RPC
 calls from SDK. This avoids a race condition that can lead to tasks being lost.
      repeated .temporal.api.enums.v1.TaskQueueType task_queue_types = 8;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of taskQueueTypes at the given index.