Package io.temporal.api.history.v1

Interface WorkflowTaskStartedEventAttributesOrBuilder

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

    • Method Detail

      • getScheduledEventId

        long getScheduledEventId()
         The id of the `WORKFLOW_TASK_SCHEDULED` event this task corresponds to
        int64 scheduled_event_id = 1;
        Returns:
        The scheduledEventId.

      • getIdentity

        java.lang.String getIdentity()
         Identity of the worker who picked up this task
        string identity = 2;
        Returns:
        The identity.

      • getIdentityBytes

        com.google.protobuf.ByteString getIdentityBytes()
         Identity of the worker who picked up this task
        string identity = 2;
        Returns:
        The bytes for identity.

      • getRequestId

        java.lang.String getRequestId()
         This field is populated from the RecordWorkflowTaskStartedRequest. Matching service would
 set the request_id on the RecordWorkflowTaskStartedRequest to a new UUID. This is useful
 in case a RecordWorkflowTaskStarted call succeed but matching doesn't get that response,
 so matching could retry and history service would return success if the request_id matches.
 In that case, matching will continue to deliver the task to worker. Without this field, history
 service would return AlreadyStarted error, and matching would drop the task.
        string request_id = 3;
        Returns:
        The requestId.

      • getRequestIdBytes

        com.google.protobuf.ByteString getRequestIdBytes()
         This field is populated from the RecordWorkflowTaskStartedRequest. Matching service would
 set the request_id on the RecordWorkflowTaskStartedRequest to a new UUID. This is useful
 in case a RecordWorkflowTaskStarted call succeed but matching doesn't get that response,
 so matching could retry and history service would return success if the request_id matches.
 In that case, matching will continue to deliver the task to worker. Without this field, history
 service would return AlreadyStarted error, and matching would drop the task.
        string request_id = 3;
        Returns:
        The bytes for requestId.

      • getSuggestContinueAsNew

        boolean getSuggestContinueAsNew()
         True if this workflow should continue-as-new soon. See `suggest_continue_as_new_reasons` for why.
        bool suggest_continue_as_new = 4;
        Returns:
        The suggestContinueAsNew.

      • getSuggestContinueAsNewReasonsList

        java.util.List<SuggestContinueAsNewReason> getSuggestContinueAsNewReasonsList()
         The reason(s) that suggest_continue_as_new is true, if it is.
 Unset if suggest_continue_as_new is false.
        repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
        Returns:
        A list containing the suggestContinueAsNewReasons.

      • getSuggestContinueAsNewReasonsCount

        int getSuggestContinueAsNewReasonsCount()
         The reason(s) that suggest_continue_as_new is true, if it is.
 Unset if suggest_continue_as_new is false.
        repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
        Returns:
        The count of suggestContinueAsNewReasons.

      • getSuggestContinueAsNewReasons

        SuggestContinueAsNewReason getSuggestContinueAsNewReasons​(int index)
         The reason(s) that suggest_continue_as_new is true, if it is.
 Unset if suggest_continue_as_new is false.
        repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The suggestContinueAsNewReasons at the given index.

      • getSuggestContinueAsNewReasonsValueList

        java.util.List<java.lang.Integer> getSuggestContinueAsNewReasonsValueList()
         The reason(s) that suggest_continue_as_new is true, if it is.
 Unset if suggest_continue_as_new is false.
        repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
        Returns:
        A list containing the enum numeric values on the wire for suggestContinueAsNewReasons.

      • getSuggestContinueAsNewReasonsValue

        int getSuggestContinueAsNewReasonsValue​(int index)
         The reason(s) that suggest_continue_as_new is true, if it is.
 Unset if suggest_continue_as_new is false.
        repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of suggestContinueAsNewReasons at the given index.

      • getTargetWorkerDeploymentVersionChanged

        boolean getTargetWorkerDeploymentVersionChanged()
         True if Workflow's Target Worker Deployment Version is different from its Pinned Version and
 the workflow is Pinned.
 Experimental.
        bool target_worker_deployment_version_changed = 9;
        Returns:
        The targetWorkerDeploymentVersionChanged.

      • getHistorySizeBytes

        long getHistorySizeBytes()
         Total history size in bytes, which the workflow might use to decide when to
 continue-as-new regardless of the suggestion. Note that history event count is
 just the event id of this event, so we don't include it explicitly here.
        int64 history_size_bytes = 5;
        Returns:
        The historySizeBytes.

      • hasWorkerVersion

        @Deprecated
boolean hasWorkerVersion()
        Deprecated.
        temporal.api.history.v1.WorkflowTaskStartedEventAttributes.worker_version is deprecated. See temporal/api/history/v1/message.proto;l=310
         Version info of the worker to whom this task was dispatched.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
        .temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
        Returns:
        Whether the workerVersion field is set.

      • getWorkerVersion

        @Deprecated
WorkerVersionStamp getWorkerVersion()
        Deprecated.
        temporal.api.history.v1.WorkflowTaskStartedEventAttributes.worker_version is deprecated. See temporal/api/history/v1/message.proto;l=310
         Version info of the worker to whom this task was dispatched.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
        .temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
        Returns:
        The workerVersion.

      • getWorkerVersionOrBuilder

        @Deprecated
WorkerVersionStampOrBuilder getWorkerVersionOrBuilder()
        Deprecated.
         Version info of the worker to whom this task was dispatched.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
        .temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];

      • getBuildIdRedirectCounter

        @Deprecated
long getBuildIdRedirectCounter()
        Deprecated.
        temporal.api.history.v1.WorkflowTaskStartedEventAttributes.build_id_redirect_counter is deprecated. See temporal/api/history/v1/message.proto;l=314
         Used by server internally to properly reapply build ID redirects to an execution
 when rebuilding it from events.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
        int64 build_id_redirect_counter = 7 [deprecated = true];
        Returns:
        The buildIdRedirectCounter.