Package io.temporal.api.history.v1

Interface WorkflowExecutionStartedEventAttributesOrBuilder

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

    • Method Detail

      • hasWorkflowType

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

      • getWorkflowType

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

      • getWorkflowTypeOrBuilder

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

      • getParentWorkflowNamespace

        java.lang.String getParentWorkflowNamespace()
         If this workflow is a child, the namespace our parent lives in.
 SDKs and UI tools should use `parent_workflow_namespace` field but server must use `parent_workflow_namespace_id` only.
        string parent_workflow_namespace = 2;
        Returns:
        The parentWorkflowNamespace.

      • getParentWorkflowNamespaceBytes

        com.google.protobuf.ByteString getParentWorkflowNamespaceBytes()
         If this workflow is a child, the namespace our parent lives in.
 SDKs and UI tools should use `parent_workflow_namespace` field but server must use `parent_workflow_namespace_id` only.
        string parent_workflow_namespace = 2;
        Returns:
        The bytes for parentWorkflowNamespace.

      • getParentWorkflowNamespaceId

        java.lang.String getParentWorkflowNamespaceId()
        string parent_workflow_namespace_id = 27;
        Returns:
        The parentWorkflowNamespaceId.

      • getParentWorkflowNamespaceIdBytes

        com.google.protobuf.ByteString getParentWorkflowNamespaceIdBytes()
        string parent_workflow_namespace_id = 27;
        Returns:
        The bytes for parentWorkflowNamespaceId.

      • hasParentWorkflowExecution

        boolean hasParentWorkflowExecution()
         Contains information about parent workflow execution that initiated the child workflow these attributes belong to.
 If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
        .temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;
        Returns:
        Whether the parentWorkflowExecution field is set.

      • getParentWorkflowExecution

        WorkflowExecution getParentWorkflowExecution()
         Contains information about parent workflow execution that initiated the child workflow these attributes belong to.
 If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
        .temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;
        Returns:
        The parentWorkflowExecution.

      • getParentWorkflowExecutionOrBuilder

        WorkflowExecutionOrBuilder getParentWorkflowExecutionOrBuilder()
         Contains information about parent workflow execution that initiated the child workflow these attributes belong to.
 If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
        .temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;

      • getParentInitiatedEventId

        long getParentInitiatedEventId()
         EventID of the child execution initiated event in parent workflow
        int64 parent_initiated_event_id = 4;
        Returns:
        The parentInitiatedEventId.

      • hasTaskQueue

        boolean hasTaskQueue()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 5;
        Returns:
        Whether the taskQueue field is set.

      • getTaskQueue

        TaskQueue getTaskQueue()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 5;
        Returns:
        The taskQueue.

      • getTaskQueueOrBuilder

        TaskQueueOrBuilder getTaskQueueOrBuilder()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 5;

      • hasInput

        boolean hasInput()
         SDK will deserialize this and provide it as arguments to the workflow function
        .temporal.api.common.v1.Payloads input = 6;
        Returns:
        Whether the input field is set.

      • getInput

        Payloads getInput()
         SDK will deserialize this and provide it as arguments to the workflow function
        .temporal.api.common.v1.Payloads input = 6;
        Returns:
        The input.

      • getInputOrBuilder

        PayloadsOrBuilder getInputOrBuilder()
         SDK will deserialize this and provide it as arguments to the workflow function
        .temporal.api.common.v1.Payloads input = 6;

      • hasWorkflowExecutionTimeout

        boolean hasWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 7;
        Returns:
        Whether the workflowExecutionTimeout field is set.

      • getWorkflowExecutionTimeout

        com.google.protobuf.Duration getWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 7;
        Returns:
        The workflowExecutionTimeout.

      • getWorkflowExecutionTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getWorkflowExecutionTimeoutOrBuilder()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 7;

      • hasWorkflowRunTimeout

        boolean hasWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 8;
        Returns:
        Whether the workflowRunTimeout field is set.

      • getWorkflowRunTimeout

        com.google.protobuf.Duration getWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 8;
        Returns:
        The workflowRunTimeout.

      • getWorkflowRunTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getWorkflowRunTimeoutOrBuilder()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 8;

      • hasWorkflowTaskTimeout

        boolean hasWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 9;
        Returns:
        Whether the workflowTaskTimeout field is set.

      • getWorkflowTaskTimeout

        com.google.protobuf.Duration getWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 9;
        Returns:
        The workflowTaskTimeout.

      • getWorkflowTaskTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getWorkflowTaskTimeoutOrBuilder()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 9;

      • getContinuedExecutionRunId

        java.lang.String getContinuedExecutionRunId()
         Run id of the previous workflow which continued-as-new or retired or cron executed into this
 workflow.
        string continued_execution_run_id = 10;
        Returns:
        The continuedExecutionRunId.

      • getContinuedExecutionRunIdBytes

        com.google.protobuf.ByteString getContinuedExecutionRunIdBytes()
         Run id of the previous workflow which continued-as-new or retired or cron executed into this
 workflow.
        string continued_execution_run_id = 10;
        Returns:
        The bytes for continuedExecutionRunId.

      • getInitiatorValue

        int getInitiatorValue()
        .temporal.api.enums.v1.ContinueAsNewInitiator initiator = 11;
        Returns:
        The enum numeric value on the wire for initiator.

      • getInitiator

        ContinueAsNewInitiator getInitiator()
        .temporal.api.enums.v1.ContinueAsNewInitiator initiator = 11;
        Returns:
        The initiator.

      • hasContinuedFailure

        boolean hasContinuedFailure()
        .temporal.api.failure.v1.Failure continued_failure = 12;
        Returns:
        Whether the continuedFailure field is set.

      • getContinuedFailure

        Failure getContinuedFailure()
        .temporal.api.failure.v1.Failure continued_failure = 12;
        Returns:
        The continuedFailure.

      • getContinuedFailureOrBuilder

        FailureOrBuilder getContinuedFailureOrBuilder()
        .temporal.api.failure.v1.Failure continued_failure = 12;

      • hasLastCompletionResult

        boolean hasLastCompletionResult()
        .temporal.api.common.v1.Payloads last_completion_result = 13;
        Returns:
        Whether the lastCompletionResult field is set.

      • getLastCompletionResult

        Payloads getLastCompletionResult()
        .temporal.api.common.v1.Payloads last_completion_result = 13;
        Returns:
        The lastCompletionResult.

      • getLastCompletionResultOrBuilder

        PayloadsOrBuilder getLastCompletionResultOrBuilder()
        .temporal.api.common.v1.Payloads last_completion_result = 13;

      • getOriginalExecutionRunId

        java.lang.String getOriginalExecutionRunId()
         This is the run id when the WorkflowExecutionStarted event was written.
 A workflow reset changes the execution run_id, but preserves this field.
        string original_execution_run_id = 14;
        Returns:
        The originalExecutionRunId.

      • getOriginalExecutionRunIdBytes

        com.google.protobuf.ByteString getOriginalExecutionRunIdBytes()
         This is the run id when the WorkflowExecutionStarted event was written.
 A workflow reset changes the execution run_id, but preserves this field.
        string original_execution_run_id = 14;
        Returns:
        The bytes for originalExecutionRunId.

      • getIdentity

        java.lang.String getIdentity()
         Identity of the client who requested this execution
        string identity = 15;
        Returns:
        The identity.

      • getIdentityBytes

        com.google.protobuf.ByteString getIdentityBytes()
         Identity of the client who requested this execution
        string identity = 15;
        Returns:
        The bytes for identity.

      • getFirstExecutionRunId

        java.lang.String getFirstExecutionRunId()
         This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset.
 Used to identify a chain.
        string first_execution_run_id = 16;
        Returns:
        The firstExecutionRunId.

      • getFirstExecutionRunIdBytes

        com.google.protobuf.ByteString getFirstExecutionRunIdBytes()
         This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset.
 Used to identify a chain.
        string first_execution_run_id = 16;
        Returns:
        The bytes for firstExecutionRunId.

      • hasRetryPolicy

        boolean hasRetryPolicy()
        .temporal.api.common.v1.RetryPolicy retry_policy = 17;
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        RetryPolicy getRetryPolicy()
        .temporal.api.common.v1.RetryPolicy retry_policy = 17;
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
        .temporal.api.common.v1.RetryPolicy retry_policy = 17;

      • getAttempt

        int getAttempt()
         Starting at 1, the number of times we have tried to execute this workflow
        int32 attempt = 18;
        Returns:
        The attempt.

      • hasWorkflowExecutionExpirationTime

        boolean hasWorkflowExecutionExpirationTime()
         The absolute time at which the workflow will be timed out.
 This is passed without change to the next run/retry of a workflow.
        .google.protobuf.Timestamp workflow_execution_expiration_time = 19;
        Returns:
        Whether the workflowExecutionExpirationTime field is set.

      • getWorkflowExecutionExpirationTime

        com.google.protobuf.Timestamp getWorkflowExecutionExpirationTime()
         The absolute time at which the workflow will be timed out.
 This is passed without change to the next run/retry of a workflow.
        .google.protobuf.Timestamp workflow_execution_expiration_time = 19;
        Returns:
        The workflowExecutionExpirationTime.

      • getWorkflowExecutionExpirationTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getWorkflowExecutionExpirationTimeOrBuilder()
         The absolute time at which the workflow will be timed out.
 This is passed without change to the next run/retry of a workflow.
        .google.protobuf.Timestamp workflow_execution_expiration_time = 19;

      • getCronSchedule

        java.lang.String getCronSchedule()
         If this workflow runs on a cron schedule, it will appear here
        string cron_schedule = 20;
        Returns:
        The cronSchedule.

      • getCronScheduleBytes

        com.google.protobuf.ByteString getCronScheduleBytes()
         If this workflow runs on a cron schedule, it will appear here
        string cron_schedule = 20;
        Returns:
        The bytes for cronSchedule.

      • hasFirstWorkflowTaskBackoff

        boolean hasFirstWorkflowTaskBackoff()
         For a cron workflow, this contains the amount of time between when this iteration of
 the cron workflow was scheduled and when it should run next per its cron_schedule.
        .google.protobuf.Duration first_workflow_task_backoff = 21;
        Returns:
        Whether the firstWorkflowTaskBackoff field is set.

      • getFirstWorkflowTaskBackoff

        com.google.protobuf.Duration getFirstWorkflowTaskBackoff()
         For a cron workflow, this contains the amount of time between when this iteration of
 the cron workflow was scheduled and when it should run next per its cron_schedule.
        .google.protobuf.Duration first_workflow_task_backoff = 21;
        Returns:
        The firstWorkflowTaskBackoff.

      • getFirstWorkflowTaskBackoffOrBuilder

        com.google.protobuf.DurationOrBuilder getFirstWorkflowTaskBackoffOrBuilder()
         For a cron workflow, this contains the amount of time between when this iteration of
 the cron workflow was scheduled and when it should run next per its cron_schedule.
        .google.protobuf.Duration first_workflow_task_backoff = 21;

      • hasMemo

        boolean hasMemo()
        .temporal.api.common.v1.Memo memo = 22;
        Returns:
        Whether the memo field is set.

      • getMemo

        Memo getMemo()
        .temporal.api.common.v1.Memo memo = 22;
        Returns:
        The memo.

      • getMemoOrBuilder

        MemoOrBuilder getMemoOrBuilder()
        .temporal.api.common.v1.Memo memo = 22;

      • hasSearchAttributes

        boolean hasSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 23;
        Returns:
        Whether the searchAttributes field is set.

      • getSearchAttributes

        SearchAttributes getSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 23;
        Returns:
        The searchAttributes.

      • getSearchAttributesOrBuilder

        SearchAttributesOrBuilder getSearchAttributesOrBuilder()
        .temporal.api.common.v1.SearchAttributes search_attributes = 23;

      • hasPrevAutoResetPoints

        boolean hasPrevAutoResetPoints()
        .temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;
        Returns:
        Whether the prevAutoResetPoints field is set.

      • getPrevAutoResetPoints

        ResetPoints getPrevAutoResetPoints()
        .temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;
        Returns:
        The prevAutoResetPoints.

      • getPrevAutoResetPointsOrBuilder

        ResetPointsOrBuilder getPrevAutoResetPointsOrBuilder()
        .temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;

      • hasHeader

        boolean hasHeader()
        .temporal.api.common.v1.Header header = 25;
        Returns:
        Whether the header field is set.

      • getHeader

        Header getHeader()
        .temporal.api.common.v1.Header header = 25;
        Returns:
        The header.

      • getHeaderOrBuilder

        HeaderOrBuilder getHeaderOrBuilder()
        .temporal.api.common.v1.Header header = 25;

      • getParentInitiatedEventVersion

        long getParentInitiatedEventVersion()
         Version of the child execution initiated event in parent workflow
 It should be used together with parent_initiated_event_id to identify
 a child initiated event for global namespace
        int64 parent_initiated_event_version = 26;
        Returns:
        The parentInitiatedEventVersion.

      • getWorkflowId

        java.lang.String getWorkflowId()
         This field is new in 1.21.
        string workflow_id = 28;
        Returns:
        The workflowId.

      • getWorkflowIdBytes

        com.google.protobuf.ByteString getWorkflowIdBytes()
         This field is new in 1.21.
        string workflow_id = 28;
        Returns:
        The bytes for workflowId.

      • hasSourceVersionStamp

        boolean hasSourceVersionStamp()
         If this workflow intends to use anything other than the current overall default version for
 the queue, then we include it here.
 Deprecated. use `inherited_build_id` instead
        .temporal.api.common.v1.WorkerVersionStamp source_version_stamp = 29;
        Returns:
        Whether the sourceVersionStamp field is set.

      • getSourceVersionStamp

        WorkerVersionStamp getSourceVersionStamp()
         If this workflow intends to use anything other than the current overall default version for
 the queue, then we include it here.
 Deprecated. use `inherited_build_id` instead
        .temporal.api.common.v1.WorkerVersionStamp source_version_stamp = 29;
        Returns:
        The sourceVersionStamp.

      • getSourceVersionStampOrBuilder

        WorkerVersionStampOrBuilder getSourceVersionStampOrBuilder()
         If this workflow intends to use anything other than the current overall default version for
 the queue, then we include it here.
 Deprecated. use `inherited_build_id` instead
        .temporal.api.common.v1.WorkerVersionStamp source_version_stamp = 29;

      • getCompletionCallbacksList

        java.util.List<Callback> getCompletionCallbacksList()
         Completion callbacks attached when this workflow was started.
        repeated .temporal.api.common.v1.Callback completion_callbacks = 30;

      • getCompletionCallbacks

        Callback getCompletionCallbacks​(int index)
         Completion callbacks attached when this workflow was started.
        repeated .temporal.api.common.v1.Callback completion_callbacks = 30;

      • getCompletionCallbacksCount

        int getCompletionCallbacksCount()
         Completion callbacks attached when this workflow was started.
        repeated .temporal.api.common.v1.Callback completion_callbacks = 30;

      • getCompletionCallbacksOrBuilderList

        java.util.List<? extends CallbackOrBuilder> getCompletionCallbacksOrBuilderList()
         Completion callbacks attached when this workflow was started.
        repeated .temporal.api.common.v1.Callback completion_callbacks = 30;

      • getCompletionCallbacksOrBuilder

        CallbackOrBuilder getCompletionCallbacksOrBuilder​(int index)
         Completion callbacks attached when this workflow was started.
        repeated .temporal.api.common.v1.Callback completion_callbacks = 30;

      • hasRootWorkflowExecution

        boolean hasRootWorkflowExecution()
         Contains information about the root workflow execution.
 The root workflow execution is defined as follows:
 1. A workflow without parent workflow is its own root workflow.
 2. A workflow that has a parent workflow has the same root workflow as its parent workflow.
 Note: workflows continued as new or reseted may or may not have parents, check examples below.
 Examples:
   Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.
     - The root workflow of all three workflows is W1.
   Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.
     - The root workflow of all three workflows is W1.
   Scenario 3: Workflow W1 continued as new W2.
     - The root workflow of W1 is W1 and the root workflow of W2 is W2.
   Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3
     - The root workflow of all three workflows is W1.
   Scenario 5: Workflow W1 is reseted, creating W2.
     - The root workflow of W1 is W1 and the root workflow of W2 is W2.
        .temporal.api.common.v1.WorkflowExecution root_workflow_execution = 31;
        Returns:
        Whether the rootWorkflowExecution field is set.

      • getRootWorkflowExecution

        WorkflowExecution getRootWorkflowExecution()
         Contains information about the root workflow execution.
 The root workflow execution is defined as follows:
 1. A workflow without parent workflow is its own root workflow.
 2. A workflow that has a parent workflow has the same root workflow as its parent workflow.
 Note: workflows continued as new or reseted may or may not have parents, check examples below.
 Examples:
   Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.
     - The root workflow of all three workflows is W1.
   Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.
     - The root workflow of all three workflows is W1.
   Scenario 3: Workflow W1 continued as new W2.
     - The root workflow of W1 is W1 and the root workflow of W2 is W2.
   Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3
     - The root workflow of all three workflows is W1.
   Scenario 5: Workflow W1 is reseted, creating W2.
     - The root workflow of W1 is W1 and the root workflow of W2 is W2.
        .temporal.api.common.v1.WorkflowExecution root_workflow_execution = 31;
        Returns:
        The rootWorkflowExecution.

      • getRootWorkflowExecutionOrBuilder

        WorkflowExecutionOrBuilder getRootWorkflowExecutionOrBuilder()
         Contains information about the root workflow execution.
 The root workflow execution is defined as follows:
 1. A workflow without parent workflow is its own root workflow.
 2. A workflow that has a parent workflow has the same root workflow as its parent workflow.
 Note: workflows continued as new or reseted may or may not have parents, check examples below.
 Examples:
   Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.
     - The root workflow of all three workflows is W1.
   Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.
     - The root workflow of all three workflows is W1.
   Scenario 3: Workflow W1 continued as new W2.
     - The root workflow of W1 is W1 and the root workflow of W2 is W2.
   Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3
     - The root workflow of all three workflows is W1.
   Scenario 5: Workflow W1 is reseted, creating W2.
     - The root workflow of W1 is W1 and the root workflow of W2 is W2.
        .temporal.api.common.v1.WorkflowExecution root_workflow_execution = 31;

      • getInheritedBuildId

        java.lang.String getInheritedBuildId()
         When present, this execution is assigned to the build ID of its parent or previous execution.
        string inherited_build_id = 32;
        Returns:
        The inheritedBuildId.

      • getInheritedBuildIdBytes

        com.google.protobuf.ByteString getInheritedBuildIdBytes()
         When present, this execution is assigned to the build ID of its parent or previous execution.
        string inherited_build_id = 32;
        Returns:
        The bytes for inheritedBuildId.