Package io.temporal.api.workflowservice.v1

Interface StartWorkflowExecutionResponseOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      PollWorkflowTaskQueueResponse getEagerWorkflowTask()
      When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will return the first workflow task to be eagerly executed.
      PollWorkflowTaskQueueResponseOrBuilder getEagerWorkflowTaskOrBuilder()
      When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will return the first workflow task to be eagerly executed.
      Link getLink()
      Link to the workflow event.
      LinkOrBuilder getLinkOrBuilder()
      Link to the workflow event.
      java.lang.String getRunId()
      The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).
      com.google.protobuf.ByteString getRunIdBytes()
      The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).
      boolean getStarted()
      If true, a new workflow was started.
      WorkflowExecutionStatus getStatus()
      Current execution status of the workflow.
      int getStatusValue()
      Current execution status of the workflow.
      boolean hasEagerWorkflowTask()
      When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will return the first workflow task to be eagerly executed.
      boolean hasLink()
      Link to the workflow event.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getRunId

        java.lang.String getRunId()
         The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).
        string run_id = 1;
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
         The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).
        string run_id = 1;
        Returns:
        The bytes for runId.

      • getStarted

        boolean getStarted()
         If true, a new workflow was started.
        bool started = 3;
        Returns:
        The started.

      • getStatusValue

        int getStatusValue()
         Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING
 unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
        .temporal.api.enums.v1.WorkflowExecutionStatus status = 5;
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        WorkflowExecutionStatus getStatus()
         Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING
 unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
        .temporal.api.enums.v1.WorkflowExecutionStatus status = 5;
        Returns:
        The status.

      • hasEagerWorkflowTask

        boolean hasEagerWorkflowTask()
         When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will
 return the first workflow task to be eagerly executed.
 The caller is expected to have a worker available to process the task.
        .temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse eager_workflow_task = 2;
        Returns:
        Whether the eagerWorkflowTask field is set.

      • getEagerWorkflowTask

        PollWorkflowTaskQueueResponse getEagerWorkflowTask()
         When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will
 return the first workflow task to be eagerly executed.
 The caller is expected to have a worker available to process the task.
        .temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse eager_workflow_task = 2;
        Returns:
        The eagerWorkflowTask.

      • getEagerWorkflowTaskOrBuilder

        PollWorkflowTaskQueueResponseOrBuilder getEagerWorkflowTaskOrBuilder()
         When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will
 return the first workflow task to be eagerly executed.
 The caller is expected to have a worker available to process the task.
        .temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse eager_workflow_task = 2;

      • hasLink

        boolean hasLink()
         Link to the workflow event.
        .temporal.api.common.v1.Link link = 4;
        Returns:
        Whether the link field is set.

      • getLink

        Link getLink()
         Link to the workflow event.
        .temporal.api.common.v1.Link link = 4;
        Returns:
        The link.

      • getLinkOrBuilder

        LinkOrBuilder getLinkOrBuilder()
         Link to the workflow event.
        .temporal.api.common.v1.Link link = 4;