Package io.temporal.api.workflowservice.v1

Class PollWorkflowTaskQueueResponse

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

    • Field Detail

      • TASK_TOKEN_FIELD_NUMBER

        public static final int TASK_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_EXECUTION_FIELD_NUMBER

        public static final int WORKFLOW_EXECUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TYPE_FIELD_NUMBER

        public static final int WORKFLOW_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREVIOUS_STARTED_EVENT_ID_FIELD_NUMBER

        public static final int PREVIOUS_STARTED_EVENT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STARTED_EVENT_ID_FIELD_NUMBER

        public static final int STARTED_EVENT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BACKLOG_COUNT_HINT_FIELD_NUMBER

        public static final int BACKLOG_COUNT_HINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEXT_PAGE_TOKEN_FIELD_NUMBER

        public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_EXECUTION_TASK_QUEUE_FIELD_NUMBER

        public static final int WORKFLOW_EXECUTION_TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEDULED_TIME_FIELD_NUMBER

        public static final int SCHEDULED_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STARTED_TIME_FIELD_NUMBER

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getPreviousStartedEventId

        public long getPreviousStartedEventId()
         The last workflow task started event which was processed by some worker for this execution.
 Will be zero if no task has ever started.
        int64 previous_started_event_id = 4;
        Specified by:
        getPreviousStartedEventId in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The previousStartedEventId.

      • getStartedEventId

        public long getStartedEventId()
         The id of the most recent workflow task started event, which will have been generated as a
 result of this poll request being served. Will be zero if the task
 does not contain any events which would advance history (no new WFT started).
 Currently this can happen for queries.
        int64 started_event_id = 5;
        Specified by:
        getStartedEventId in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The startedEventId.

      • getBacklogCountHint

        public long getBacklogCountHint()
         A hint that there are more tasks already present in this task queue. Can be used to
 prioritize draining a sticky queue before polling from a normal queue.
        int64 backlog_count_hint = 7;
        Specified by:
        getBacklogCountHint in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The backlogCountHint.

      • hasHistory

        public boolean hasHistory()
         The history for this workflow, which will either be complete or partial. Partial histories
 are sent to workers who have signaled that they are using a sticky queue when completing
 a workflow task.
        .temporal.api.history.v1.History history = 8;
        Specified by:
        hasHistory in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        Whether the history field is set.

      • getHistory

        public History getHistory()
         The history for this workflow, which will either be complete or partial. Partial histories
 are sent to workers who have signaled that they are using a sticky queue when completing
 a workflow task.
        .temporal.api.history.v1.History history = 8;
        Specified by:
        getHistory in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The history.

      • getHistoryOrBuilder

        public HistoryOrBuilder getHistoryOrBuilder()
         The history for this workflow, which will either be complete or partial. Partial histories
 are sent to workers who have signaled that they are using a sticky queue when completing
 a workflow task.
        .temporal.api.history.v1.History history = 8;
        Specified by:
        getHistoryOrBuilder in interface PollWorkflowTaskQueueResponseOrBuilder

      • getNextPageToken

        public com.google.protobuf.ByteString getNextPageToken()
         Will be set if there are more history events than were included in this response. Such events
 should be fetched via `GetWorkflowExecutionHistory`.
        bytes next_page_token = 9;
        Specified by:
        getNextPageToken in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The nextPageToken.

      • hasQuery

        public boolean hasQuery()
         Legacy queries appear in this field. The query must be responded to via
 `RespondQueryTaskCompleted`. If the workflow is already closed (queries are permitted on
 closed workflows) then the `history` field will be populated with the entire history. It
 may also be populated if this task originates on a non-sticky queue.
        .temporal.api.query.v1.WorkflowQuery query = 10;
        Specified by:
        hasQuery in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        Whether the query field is set.

      • getQuery

        public WorkflowQuery getQuery()
         Legacy queries appear in this field. The query must be responded to via
 `RespondQueryTaskCompleted`. If the workflow is already closed (queries are permitted on
 closed workflows) then the `history` field will be populated with the entire history. It
 may also be populated if this task originates on a non-sticky queue.
        .temporal.api.query.v1.WorkflowQuery query = 10;
        Specified by:
        getQuery in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The query.

      • getQueryOrBuilder

        public WorkflowQueryOrBuilder getQueryOrBuilder()
         Legacy queries appear in this field. The query must be responded to via
 `RespondQueryTaskCompleted`. If the workflow is already closed (queries are permitted on
 closed workflows) then the `history` field will be populated with the entire history. It
 may also be populated if this task originates on a non-sticky queue.
        .temporal.api.query.v1.WorkflowQuery query = 10;
        Specified by:
        getQueryOrBuilder in interface PollWorkflowTaskQueueResponseOrBuilder

      • hasWorkflowExecutionTaskQueue

        public boolean hasWorkflowExecutionTaskQueue()
         The task queue this task originated from, which will always be the original non-sticky name
 for the queue, even if this response came from polling a sticky queue.
        .temporal.api.taskqueue.v1.TaskQueue workflow_execution_task_queue = 11;
        Specified by:
        hasWorkflowExecutionTaskQueue in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        Whether the workflowExecutionTaskQueue field is set.

      • getWorkflowExecutionTaskQueue

        public TaskQueue getWorkflowExecutionTaskQueue()
         The task queue this task originated from, which will always be the original non-sticky name
 for the queue, even if this response came from polling a sticky queue.
        .temporal.api.taskqueue.v1.TaskQueue workflow_execution_task_queue = 11;
        Specified by:
        getWorkflowExecutionTaskQueue in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        The workflowExecutionTaskQueue.

      • hasScheduledTime

        public boolean hasScheduledTime()
         When this task was scheduled by the server
        .google.protobuf.Timestamp scheduled_time = 12;
        Specified by:
        hasScheduledTime in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        Whether the scheduledTime field is set.

      • hasStartedTime

        public boolean hasStartedTime()
         When the current workflow task started event was generated, meaning the current attempt.
        .google.protobuf.Timestamp started_time = 13;
        Specified by:
        hasStartedTime in interface PollWorkflowTaskQueueResponseOrBuilder
        Returns:
        Whether the startedTime field is set.

      • containsQueries

        public boolean containsQueries​(java.lang.String key)
         Queries that should be executed after applying the history in this task. Responses should be
 attached to `RespondWorkflowTaskCompletedRequest::query_results`
        map<string, .temporal.api.query.v1.WorkflowQuery> queries = 14;
        Specified by:
        containsQueries in interface PollWorkflowTaskQueueResponseOrBuilder

      • getQueriesMap

        public java.util.Map<java.lang.String,​WorkflowQuery> getQueriesMap()
         Queries that should be executed after applying the history in this task. Responses should be
 attached to `RespondWorkflowTaskCompletedRequest::query_results`
        map<string, .temporal.api.query.v1.WorkflowQuery> queries = 14;
        Specified by:
        getQueriesMap in interface PollWorkflowTaskQueueResponseOrBuilder

      • getQueriesOrDefault

        public WorkflowQuery getQueriesOrDefault​(java.lang.String key,
                                         WorkflowQuery defaultValue)
         Queries that should be executed after applying the history in this task. Responses should be
 attached to `RespondWorkflowTaskCompletedRequest::query_results`
        map<string, .temporal.api.query.v1.WorkflowQuery> queries = 14;
        Specified by:
        getQueriesOrDefault in interface PollWorkflowTaskQueueResponseOrBuilder

      • getQueriesOrThrow

        public WorkflowQuery getQueriesOrThrow​(java.lang.String key)
         Queries that should be executed after applying the history in this task. Responses should be
 attached to `RespondWorkflowTaskCompletedRequest::query_results`
        map<string, .temporal.api.query.v1.WorkflowQuery> queries = 14;
        Specified by:
        getQueriesOrThrow in interface PollWorkflowTaskQueueResponseOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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