Interface WorkflowExecutionInfoOrBuilder

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

  • Method Details

    • hasExecution

      boolean hasExecution()
      .temporal.api.common.v1.WorkflowExecution execution = 1;
      Returns:
      Whether the execution field is set.

    • getExecution

      WorkflowExecution getExecution()
      .temporal.api.common.v1.WorkflowExecution execution = 1;
      Returns:
      The execution.

    • getExecutionOrBuilder

      WorkflowExecutionOrBuilder getExecutionOrBuilder()
      .temporal.api.common.v1.WorkflowExecution execution = 1;

    • hasType

      boolean hasType()
      .temporal.api.common.v1.WorkflowType type = 2;
      Returns:
      Whether the type field is set.

    • getType

      WorkflowType getType()
      .temporal.api.common.v1.WorkflowType type = 2;
      Returns:
      The type.

    • getTypeOrBuilder

      WorkflowTypeOrBuilder getTypeOrBuilder()
      .temporal.api.common.v1.WorkflowType type = 2;

    • hasStartTime

      boolean hasStartTime()
      .google.protobuf.Timestamp start_time = 3;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
      .google.protobuf.Timestamp start_time = 3;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
      .google.protobuf.Timestamp start_time = 3;

    • hasCloseTime

      boolean hasCloseTime()
      .google.protobuf.Timestamp close_time = 4;
      Returns:
      Whether the closeTime field is set.

    • getCloseTime

      com.google.protobuf.Timestamp getCloseTime()
      .google.protobuf.Timestamp close_time = 4;
      Returns:
      The closeTime.

    • getCloseTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCloseTimeOrBuilder()
      .google.protobuf.Timestamp close_time = 4;

    • getStatusValue

      int getStatusValue()
      .temporal.api.enums.v1.WorkflowExecutionStatus status = 5;
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      WorkflowExecutionStatus getStatus()
      .temporal.api.enums.v1.WorkflowExecutionStatus status = 5;
      Returns:
      The status.

    • getHistoryLength

      long getHistoryLength()
      int64 history_length = 6;
      Returns:
      The historyLength.

    • getParentNamespaceId

      String getParentNamespaceId()
      string parent_namespace_id = 7;
      Returns:
      The parentNamespaceId.

    • getParentNamespaceIdBytes

      com.google.protobuf.ByteString getParentNamespaceIdBytes()
      string parent_namespace_id = 7;
      Returns:
      The bytes for parentNamespaceId.

    • hasParentExecution

      boolean hasParentExecution()
      .temporal.api.common.v1.WorkflowExecution parent_execution = 8;
      Returns:
      Whether the parentExecution field is set.

    • getParentExecution

      WorkflowExecution getParentExecution()
      .temporal.api.common.v1.WorkflowExecution parent_execution = 8;
      Returns:
      The parentExecution.

    • getParentExecutionOrBuilder

      WorkflowExecutionOrBuilder getParentExecutionOrBuilder()
      .temporal.api.common.v1.WorkflowExecution parent_execution = 8;

    • hasExecutionTime

      boolean hasExecutionTime()
      .google.protobuf.Timestamp execution_time = 9;
      Returns:
      Whether the executionTime field is set.

    • getExecutionTime

      com.google.protobuf.Timestamp getExecutionTime()
      .google.protobuf.Timestamp execution_time = 9;
      Returns:
      The executionTime.

    • getExecutionTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExecutionTimeOrBuilder()
      .google.protobuf.Timestamp execution_time = 9;

    • hasMemo

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

    • getMemo

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

    • getMemoOrBuilder

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

    • hasSearchAttributes

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

    • getSearchAttributes

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

    • getSearchAttributesOrBuilder

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

    • hasAutoResetPoints

      boolean hasAutoResetPoints()
      .temporal.api.workflow.v1.ResetPoints auto_reset_points = 12;
      Returns:
      Whether the autoResetPoints field is set.

    • getAutoResetPoints

      ResetPoints getAutoResetPoints()
      .temporal.api.workflow.v1.ResetPoints auto_reset_points = 12;
      Returns:
      The autoResetPoints.

    • getAutoResetPointsOrBuilder

      ResetPointsOrBuilder getAutoResetPointsOrBuilder()
      .temporal.api.workflow.v1.ResetPoints auto_reset_points = 12;

    • getTaskQueue

      String getTaskQueue()
      string task_queue = 13;
      Returns:
      The taskQueue.

    • getTaskQueueBytes

      com.google.protobuf.ByteString getTaskQueueBytes()
      string task_queue = 13;
      Returns:
      The bytes for taskQueue.

    • getStateTransitionCount

      long getStateTransitionCount()
      int64 state_transition_count = 14;
      Returns:
      The stateTransitionCount.

    • getHistorySizeBytes

      long getHistorySizeBytes()
      int64 history_size_bytes = 15;
      Returns:
      The historySizeBytes.

    • hasMostRecentWorkerVersionStamp

      @Deprecated boolean hasMostRecentWorkerVersionStamp()
      Deprecated.
      temporal.api.workflow.v1.WorkflowExecutionInfo.most_recent_worker_version_stamp is deprecated. See temporal/api/workflow/v1/message.proto;l=47
       If set, the most recent worker version stamp that appeared in a workflow task completion
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      .temporal.api.common.v1.WorkerVersionStamp most_recent_worker_version_stamp = 16 [deprecated = true];
      Returns:
      Whether the mostRecentWorkerVersionStamp field is set.

    • getMostRecentWorkerVersionStamp

      @Deprecated WorkerVersionStamp getMostRecentWorkerVersionStamp()
      Deprecated.
      temporal.api.workflow.v1.WorkflowExecutionInfo.most_recent_worker_version_stamp is deprecated. See temporal/api/workflow/v1/message.proto;l=47
       If set, the most recent worker version stamp that appeared in a workflow task completion
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      .temporal.api.common.v1.WorkerVersionStamp most_recent_worker_version_stamp = 16 [deprecated = true];
      Returns:
      The mostRecentWorkerVersionStamp.

    • getMostRecentWorkerVersionStampOrBuilder

      @Deprecated WorkerVersionStampOrBuilder getMostRecentWorkerVersionStampOrBuilder()
      Deprecated.
       If set, the most recent worker version stamp that appeared in a workflow task completion
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      .temporal.api.common.v1.WorkerVersionStamp most_recent_worker_version_stamp = 16 [deprecated = true];

    • hasExecutionDuration

      boolean hasExecutionDuration()
       Workflow execution duration is defined as difference between close time and execution time.
 This field is only populated if the workflow is closed.
      .google.protobuf.Duration execution_duration = 17;
      Returns:
      Whether the executionDuration field is set.

    • getExecutionDuration

      com.google.protobuf.Duration getExecutionDuration()
       Workflow execution duration is defined as difference between close time and execution time.
 This field is only populated if the workflow is closed.
      .google.protobuf.Duration execution_duration = 17;
      Returns:
      The executionDuration.

    • getExecutionDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder()
       Workflow execution duration is defined as difference between close time and execution time.
 This field is only populated if the workflow is closed.
      .google.protobuf.Duration execution_duration = 17;

    • hasRootExecution

      boolean hasRootExecution()
       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_execution = 18;
      Returns:
      Whether the rootExecution field is set.

    • getRootExecution

      WorkflowExecution getRootExecution()
       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_execution = 18;
      Returns:
      The rootExecution.

    • getRootExecutionOrBuilder

      WorkflowExecutionOrBuilder getRootExecutionOrBuilder()
       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_execution = 18;

    • getAssignedBuildId

      @Deprecated String getAssignedBuildId()
      Deprecated.
      temporal.api.workflow.v1.WorkflowExecutionInfo.assigned_build_id is deprecated. See temporal/api/workflow/v1/message.proto;l=76
       The currently assigned build ID for this execution. Presence of this value means worker versioning is used
 for this execution. Assigned build ID is selected based on Worker Versioning Assignment Rules
 when the first workflow task of the execution is scheduled. If the first workflow task fails and is scheduled
 again, the assigned build ID may change according to the latest versioning rules.
 Assigned build ID can also change in the middle of a execution if Compatible Redirect Rules are applied to
 this execution.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      string assigned_build_id = 19 [deprecated = true];
      Returns:
      The assignedBuildId.

    • getAssignedBuildIdBytes

      @Deprecated com.google.protobuf.ByteString getAssignedBuildIdBytes()
      Deprecated.
      temporal.api.workflow.v1.WorkflowExecutionInfo.assigned_build_id is deprecated. See temporal/api/workflow/v1/message.proto;l=76
       The currently assigned build ID for this execution. Presence of this value means worker versioning is used
 for this execution. Assigned build ID is selected based on Worker Versioning Assignment Rules
 when the first workflow task of the execution is scheduled. If the first workflow task fails and is scheduled
 again, the assigned build ID may change according to the latest versioning rules.
 Assigned build ID can also change in the middle of a execution if Compatible Redirect Rules are applied to
 this execution.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      string assigned_build_id = 19 [deprecated = true];
      Returns:
      The bytes for assignedBuildId.

    • getInheritedBuildId

      @Deprecated String getInheritedBuildId()
      Deprecated.
      temporal.api.workflow.v1.WorkflowExecutionInfo.inherited_build_id is deprecated. See temporal/api/workflow/v1/message.proto;l=80
       Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead
 of using the assignment rules.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      string inherited_build_id = 20 [deprecated = true];
      Returns:
      The inheritedBuildId.

    • getInheritedBuildIdBytes

      @Deprecated com.google.protobuf.ByteString getInheritedBuildIdBytes()
      Deprecated.
      temporal.api.workflow.v1.WorkflowExecutionInfo.inherited_build_id is deprecated. See temporal/api/workflow/v1/message.proto;l=80
       Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead
 of using the assignment rules.
 Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
      string inherited_build_id = 20 [deprecated = true];
      Returns:
      The bytes for inheritedBuildId.

    • getFirstRunId

      String getFirstRunId()
       The first run ID in the execution chain.
 Executions created via the following operations are considered to be in the same chain
 - ContinueAsNew
 - Workflow Retry
 - Workflow Reset
 - Cron Schedule
      string first_run_id = 21;
      Returns:
      The firstRunId.

    • getFirstRunIdBytes

      com.google.protobuf.ByteString getFirstRunIdBytes()
       The first run ID in the execution chain.
 Executions created via the following operations are considered to be in the same chain
 - ContinueAsNew
 - Workflow Retry
 - Workflow Reset
 - Cron Schedule
      string first_run_id = 21;
      Returns:
      The bytes for firstRunId.

    • hasVersioningInfo

      boolean hasVersioningInfo()
       Absent value means the workflow execution is not versioned. When present, the execution might
 be versioned or unversioned, depending on `versioning_info.behavior` and `versioning_info.versioning_override`.
 Experimental. Versioning info is experimental and might change in the future.
      .temporal.api.workflow.v1.WorkflowExecutionVersioningInfo versioning_info = 22;
      Returns:
      Whether the versioningInfo field is set.

    • getVersioningInfo

      WorkflowExecutionVersioningInfo getVersioningInfo()
       Absent value means the workflow execution is not versioned. When present, the execution might
 be versioned or unversioned, depending on `versioning_info.behavior` and `versioning_info.versioning_override`.
 Experimental. Versioning info is experimental and might change in the future.
      .temporal.api.workflow.v1.WorkflowExecutionVersioningInfo versioning_info = 22;
      Returns:
      The versioningInfo.

    • getVersioningInfoOrBuilder

      WorkflowExecutionVersioningInfoOrBuilder getVersioningInfoOrBuilder()
       Absent value means the workflow execution is not versioned. When present, the execution might
 be versioned or unversioned, depending on `versioning_info.behavior` and `versioning_info.versioning_override`.
 Experimental. Versioning info is experimental and might change in the future.
      .temporal.api.workflow.v1.WorkflowExecutionVersioningInfo versioning_info = 22;

    • getWorkerDeploymentName

      String getWorkerDeploymentName()
       The name of Worker Deployment that completed the most recent workflow task.
      string worker_deployment_name = 23;
      Returns:
      The workerDeploymentName.

    • getWorkerDeploymentNameBytes

      com.google.protobuf.ByteString getWorkerDeploymentNameBytes()
       The name of Worker Deployment that completed the most recent workflow task.
      string worker_deployment_name = 23;
      Returns:
      The bytes for workerDeploymentName.

    • hasPriority

      boolean hasPriority()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 24;
      Returns:
      Whether the priority field is set.

    • getPriority

      Priority getPriority()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 24;
      Returns:
      The priority.

    • getPriorityOrBuilder

      PriorityOrBuilder getPriorityOrBuilder()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 24;

    • getExternalPayloadSizeBytes

      long getExternalPayloadSizeBytes()
       Total size in bytes of all external payloads referenced in workflow history.
      int64 external_payload_size_bytes = 25;
      Returns:
      The externalPayloadSizeBytes.

    • getExternalPayloadCount

      long getExternalPayloadCount()
       Count of external payloads referenced in workflow history.
      int64 external_payload_count = 26;
      Returns:
      The externalPayloadCount.