Package io.temporal.api.workflowservice.v1

Class ShutdownWorkerRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ShutdownWorkerRequestOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:ShutdownWorkerRequest.java.pb.meta")
public final class ShutdownWorkerRequest
extends com.google.protobuf.GeneratedMessageV3
implements ShutdownWorkerRequestOrBuilder
    Protobuf type temporal.api.workflowservice.v1.ShutdownWorkerRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ShutdownWorkerRequest.Builder
      Protobuf type temporal.api.workflowservice.v1.ShutdownWorkerRequest

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • STICKY_TASK_QUEUE_FIELD_NUMBER

        public static final int STICKY_TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKER_HEARTBEAT_FIELD_NUMBER

        public static final int WORKER_HEARTBEAT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKER_INSTANCE_KEY_FIELD_NUMBER

        public static final int WORKER_INSTANCE_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_FIELD_NUMBER

        public static final int TASK_QUEUE_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

    • 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

      • getStickyTaskQueue

        public java.lang.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;
        Specified by:
        getStickyTaskQueue in interface ShutdownWorkerRequestOrBuilder
        Returns:
        The stickyTaskQueue.

      • getStickyTaskQueueBytes

        public 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;
        Specified by:
        getStickyTaskQueueBytes in interface ShutdownWorkerRequestOrBuilder
        Returns:
        The bytes for stickyTaskQueue.

      • hasWorkerHeartbeat

        public boolean hasWorkerHeartbeat()
        .temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;
        Specified by:
        hasWorkerHeartbeat in interface ShutdownWorkerRequestOrBuilder
        Returns:
        Whether the workerHeartbeat field is set.

      • getWorkerInstanceKey

        public java.lang.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;
        Specified by:
        getWorkerInstanceKey in interface ShutdownWorkerRequestOrBuilder
        Returns:
        The workerInstanceKey.

      • getWorkerInstanceKeyBytes

        public 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;
        Specified by:
        getWorkerInstanceKeyBytes in interface ShutdownWorkerRequestOrBuilder
        Returns:
        The bytes for workerInstanceKey.

      • getTaskQueue

        public java.lang.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;
        Specified by:
        getTaskQueue in interface ShutdownWorkerRequestOrBuilder
        Returns:
        The taskQueue.

      • getTaskQueueBytes

        public 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;
        Specified by:
        getTaskQueueBytes in interface ShutdownWorkerRequestOrBuilder
        Returns:
        The bytes for taskQueue.

      • getTaskQueueTypesList

        public java.util.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;
        Specified by:
        getTaskQueueTypesList in interface ShutdownWorkerRequestOrBuilder
        Returns:
        A list containing the taskQueueTypes.

      • getTaskQueueTypesCount

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

      • getTaskQueueTypes

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

      • getTaskQueueTypesValueList

        public java.util.List<java.lang.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;
        Specified by:
        getTaskQueueTypesValueList in interface ShutdownWorkerRequestOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for taskQueueTypes.

      • getTaskQueueTypesValue

        public 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;
        Specified by:
        getTaskQueueTypesValue in interface ShutdownWorkerRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of taskQueueTypes at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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