Package io.temporal.api.enums.v1

Enum UpdateWorkflowExecutionLifecycleStage

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<UpdateWorkflowExecutionLifecycleStage>
    @Generated(value="protoc",
           comments="annotations:UpdateWorkflowExecutionLifecycleStage.java.pb.meta")
public enum UpdateWorkflowExecutionLifecycleStage
extends java.lang.Enum<UpdateWorkflowExecutionLifecycleStage>
implements com.google.protobuf.ProtocolMessageEnum
     UpdateWorkflowExecutionLifecycleStage is specified by clients invoking
 Workflow Updates and used to indicate to the server how long the
 client wishes to wait for a return value from the API. If any value other
 than UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED is sent by the
 client then the API will complete before the Update is finished and will
 return a handle to the running Update so that it can later be polled for
 completion.
 If specified stage wasn't reached before server timeout, server returns
 actual stage reached.
    Protobuf enum temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage

    • Enum Constant Detail

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED

        public static final UpdateWorkflowExecutionLifecycleStage UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED
         An unspecified value for this enum.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED = 0;

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED

        public static final UpdateWorkflowExecutionLifecycleStage UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED
         The API call will not return until the Update request has been admitted
 by the server - it may be the case that due to a considerations like load
 or resource limits that an Update is made to wait before the server will
 indicate that it has been received and will be processed. This value
 does not wait for any sort of acknowledgement from a worker.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED = 1;

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED

        public static final UpdateWorkflowExecutionLifecycleStage UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED
         The API call will not return until the Update has passed validation on a worker.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED = 2;

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED

        public static final UpdateWorkflowExecutionLifecycleStage UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED
         The API call will not return until the Update has executed to completion
 on a worker and has either been rejected or returned a value or an error.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED = 3;

    • Field Detail

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED_VALUE

        public static final int UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED_VALUE
         An unspecified value for this enum.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED_VALUE

        public static final int UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED_VALUE
         The API call will not return until the Update request has been admitted
 by the server - it may be the case that due to a considerations like load
 or resource limits that an Update is made to wait before the server will
 indicate that it has been received and will be processed. This value
 does not wait for any sort of acknowledgement from a worker.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED = 1;
        See Also:
        Constant Field Values

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED_VALUE

        public static final int UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED_VALUE
         The API call will not return until the Update has passed validation on a worker.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED = 2;
        See Also:
        Constant Field Values

      • UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED_VALUE

        public static final int UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED_VALUE
         The API call will not return until the Update has executed to completion
 on a worker and has either been rejected or returned a value or an error.
        UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED = 3;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static UpdateWorkflowExecutionLifecycleStage[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (UpdateWorkflowExecutionLifecycleStage c : UpdateWorkflowExecutionLifecycleStage.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static UpdateWorkflowExecutionLifecycleStage valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static UpdateWorkflowExecutionLifecycleStage valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • forNumber

        public static UpdateWorkflowExecutionLifecycleStage forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static UpdateWorkflowExecutionLifecycleStage valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null