Package io.temporal.api.workflowservice.v1

Interface PollWorkflowExecutionUpdateResponseOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Outcome getOutcome()
      The outcome of the update if and only if the update has completed.
      OutcomeOrBuilder getOutcomeOrBuilder()
      The outcome of the update if and only if the update has completed.
      UpdateWorkflowExecutionLifecycleStage getStage()
      The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.
      int getStageValue()
      The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.
      UpdateRef getUpdateRef()
      Sufficient information to address this Update.
      UpdateRefOrBuilder getUpdateRefOrBuilder()
      Sufficient information to address this Update.
      boolean hasOutcome()
      The outcome of the update if and only if the update has completed.
      boolean hasUpdateRef()
      Sufficient information to address this Update.

      • 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

      • hasOutcome

        boolean hasOutcome()
         The outcome of the update if and only if the update has completed. If
 this response is being returned before the update has completed (e.g. due
 to the specification of a wait policy that only waits on
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will
 not be set.
        .temporal.api.update.v1.Outcome outcome = 1;
        Returns:
        Whether the outcome field is set.

      • getOutcome

        Outcome getOutcome()
         The outcome of the update if and only if the update has completed. If
 this response is being returned before the update has completed (e.g. due
 to the specification of a wait policy that only waits on
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will
 not be set.
        .temporal.api.update.v1.Outcome outcome = 1;
        Returns:
        The outcome.

      • getOutcomeOrBuilder

        OutcomeOrBuilder getOutcomeOrBuilder()
         The outcome of the update if and only if the update has completed. If
 this response is being returned before the update has completed (e.g. due
 to the specification of a wait policy that only waits on
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will
 not be set.
        .temporal.api.update.v1.Outcome outcome = 1;

      • getStageValue

        int getStageValue()
         The most advanced lifecycle stage that the Update is known to have
 reached, where lifecycle stages are ordered
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED <
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED <
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED <
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.
 UNSPECIFIED will be returned if and only if the server's maximum wait
 time was reached before the Update reached the stage specified in the
 request WaitPolicy, and before the context deadline expired; clients may
 may then retry the call as needed.
        .temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 2;
        Returns:
        The enum numeric value on the wire for stage.

      • getStage

        UpdateWorkflowExecutionLifecycleStage getStage()
         The most advanced lifecycle stage that the Update is known to have
 reached, where lifecycle stages are ordered
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED <
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED <
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED <
 UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.
 UNSPECIFIED will be returned if and only if the server's maximum wait
 time was reached before the Update reached the stage specified in the
 request WaitPolicy, and before the context deadline expired; clients may
 may then retry the call as needed.
        .temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 2;
        Returns:
        The stage.

      • hasUpdateRef

        boolean hasUpdateRef()
         Sufficient information to address this Update.
        .temporal.api.update.v1.UpdateRef update_ref = 3;
        Returns:
        Whether the updateRef field is set.

      • getUpdateRef

        UpdateRef getUpdateRef()
         Sufficient information to address this Update.
        .temporal.api.update.v1.UpdateRef update_ref = 3;
        Returns:
        The updateRef.

      • getUpdateRefOrBuilder

        UpdateRefOrBuilder getUpdateRefOrBuilder()
         Sufficient information to address this Update.
        .temporal.api.update.v1.UpdateRef update_ref = 3;