Package io.temporal.api.workflowservice.v1

Interface PollWorkflowTaskQueueResponseOrBuilder

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

    • Method Detail

      • getTaskToken

        com.google.protobuf.ByteString getTaskToken()
         A unique identifier for this task
        bytes task_token = 1;
        Returns:
        The taskToken.

      • hasWorkflowExecution

        boolean hasWorkflowExecution()
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
        Returns:
        Whether the workflowExecution field is set.

      • getWorkflowExecution

        WorkflowExecution getWorkflowExecution()
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
        Returns:
        The workflowExecution.

      • getWorkflowExecutionOrBuilder

        WorkflowExecutionOrBuilder getWorkflowExecutionOrBuilder()
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 2;

      • hasWorkflowType

        boolean hasWorkflowType()
        .temporal.api.common.v1.WorkflowType workflow_type = 3;
        Returns:
        Whether the workflowType field is set.

      • getWorkflowType

        WorkflowType getWorkflowType()
        .temporal.api.common.v1.WorkflowType workflow_type = 3;
        Returns:
        The workflowType.

      • getWorkflowTypeOrBuilder

        WorkflowTypeOrBuilder getWorkflowTypeOrBuilder()
        .temporal.api.common.v1.WorkflowType workflow_type = 3;

      • getPreviousStartedEventId

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

      • getStartedEventId

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

      • getAttempt

        int getAttempt()
         Starting at 1, the number of attempts to complete this task by any worker.
        int32 attempt = 6;
        Returns:
        The attempt.

      • getBacklogCountHint

        long getBacklogCountHint()
         A hint that there are more tasks already present in this task queue 
 partition. Can be used to prioritize draining a sticky queue.
 Specifically, the returned number is the number of tasks remaining in
 the in-memory buffer for this partition, which is currently capped at
 1000. Because sticky queues only have one partition, this number is 
 more useful when draining them. Normal queues, typically having more than one 
 partition, will return a number representing only some portion of the 
 overall backlog. Subsequent RPCs may not hit the same partition as 
 this call.
        int64 backlog_count_hint = 7;
        Returns:
        The backlogCountHint.

      • hasHistory

        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;
        Returns:
        Whether the history field is set.

      • getHistory

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

      • getHistoryOrBuilder

        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;

      • getNextPageToken

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

      • hasQuery

        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;
        Returns:
        Whether the query field is set.

      • getQuery

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

      • getQueryOrBuilder

        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;

      • hasWorkflowExecutionTaskQueue

        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;
        Returns:
        Whether the workflowExecutionTaskQueue field is set.

      • getWorkflowExecutionTaskQueue

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

      • getWorkflowExecutionTaskQueueOrBuilder

        TaskQueueOrBuilder getWorkflowExecutionTaskQueueOrBuilder()
         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;

      • hasScheduledTime

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

      • getScheduledTime

        com.google.protobuf.Timestamp getScheduledTime()
         When this task was scheduled by the server
        .google.protobuf.Timestamp scheduled_time = 12;
        Returns:
        The scheduledTime.

      • getScheduledTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getScheduledTimeOrBuilder()
         When this task was scheduled by the server
        .google.protobuf.Timestamp scheduled_time = 12;

      • hasStartedTime

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

      • getStartedTime

        com.google.protobuf.Timestamp getStartedTime()
         When the current workflow task started event was generated, meaning the current attempt.
        .google.protobuf.Timestamp started_time = 13;
        Returns:
        The startedTime.

      • getStartedTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartedTimeOrBuilder()
         When the current workflow task started event was generated, meaning the current attempt.
        .google.protobuf.Timestamp started_time = 13;

      • getQueriesCount

        int getQueriesCount()
         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;

      • containsQueries

        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;

      • getQueriesMap

        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;

      • getQueriesOrDefault

        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;

      • getQueriesOrThrow

        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;

      • getMessagesList

        java.util.List<Message> getMessagesList()
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 15;

      • getMessages

        Message getMessages​(int index)
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 15;

      • getMessagesCount

        int getMessagesCount()
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 15;

      • getMessagesOrBuilderList

        java.util.List<? extends MessageOrBuilder> getMessagesOrBuilderList()
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 15;

      • getMessagesOrBuilder

        MessageOrBuilder getMessagesOrBuilder​(int index)
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 15;