Package io.temporal.api.common.v1

Class ResetOptions

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResetOptionsOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:ResetOptions.java.pb.meta")
public final class ResetOptions
extends com.google.protobuf.GeneratedMessageV3
implements ResetOptionsOrBuilder
     Describes where and how to reset a workflow, used for batch reset currently
 and may be used for single-workflow reset later.
    Protobuf type temporal.api.common.v1.ResetOptions
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ResetOptions.Builder
      Describes where and how to reset a workflow, used for batch reset currently and may be used for single-workflow reset later.
      static class  ResetOptions.TargetCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getBuildId()
      Resets to the first workflow task processed by this build id.
      com.google.protobuf.ByteString getBuildIdBytes()
      Resets to the first workflow task processed by this build id.
      boolean getCurrentRunOnly()
      If true, limit the reset to only within the current run.
      static ResetOptions getDefaultInstance()  
      ResetOptions getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Empty getFirstWorkflowTask()
      Resets to the first workflow task completed or started event.
      com.google.protobuf.EmptyOrBuilder getFirstWorkflowTaskOrBuilder()
      Resets to the first workflow task completed or started event.
      com.google.protobuf.Empty getLastWorkflowTask()
      Resets to the last workflow task completed or started event.
      com.google.protobuf.EmptyOrBuilder getLastWorkflowTaskOrBuilder()
      Resets to the last workflow task completed or started event.
      com.google.protobuf.Parser<ResetOptions> getParserForType()  
      ResetReapplyExcludeType getResetReapplyExcludeTypes​(int index)
      Event types not to be reapplied
      int getResetReapplyExcludeTypesCount()
      Event types not to be reapplied
      java.util.List<ResetReapplyExcludeType> getResetReapplyExcludeTypesList()
      Event types not to be reapplied
      int getResetReapplyExcludeTypesValue​(int index)
      Event types not to be reapplied
      java.util.List<java.lang.Integer> getResetReapplyExcludeTypesValueList()
      Event types not to be reapplied
      ResetReapplyType getResetReapplyType()
      Deprecated.
      temporal.api.common.v1.ResetOptions.reset_reapply_type is deprecated.
      int getResetReapplyTypeValue()
      Deprecated.
      temporal.api.common.v1.ResetOptions.reset_reapply_type is deprecated.
      int getSerializedSize()  
      ResetOptions.TargetCase getTargetCase()  
      long getWorkflowTaskId()
      The id of a specific `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or `WORKFLOW_TASK_STARTED` event to reset to.
      boolean hasBuildId()
      Resets to the first workflow task processed by this build id.
      boolean hasFirstWorkflowTask()
      Resets to the first workflow task completed or started event.
      int hashCode()  
      boolean hasLastWorkflowTask()
      Resets to the last workflow task completed or started event.
      boolean hasWorkflowTaskId()
      The id of a specific `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or `WORKFLOW_TASK_STARTED` event to reset to.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ResetOptions.Builder newBuilder()  
      static ResetOptions.Builder newBuilder​(ResetOptions prototype)  
      ResetOptions.Builder newBuilderForType()  
      protected ResetOptions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ResetOptions parseDelimitedFrom​(java.io.InputStream input)  
      static ResetOptions parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ResetOptions parseFrom​(byte[] data)  
      static ResetOptions parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ResetOptions parseFrom​(com.google.protobuf.ByteString data)  
      static ResetOptions parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ResetOptions parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ResetOptions parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ResetOptions parseFrom​(java.io.InputStream input)  
      static ResetOptions parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ResetOptions parseFrom​(java.nio.ByteBuffer data)  
      static ResetOptions parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ResetOptions> parser()  
      ResetOptions.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Field Detail

      • FIRST_WORKFLOW_TASK_FIELD_NUMBER

        public static final int FIRST_WORKFLOW_TASK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LAST_WORKFLOW_TASK_FIELD_NUMBER

        public static final int LAST_WORKFLOW_TASK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TASK_ID_FIELD_NUMBER

        public static final int WORKFLOW_TASK_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESET_REAPPLY_TYPE_FIELD_NUMBER

        public static final int RESET_REAPPLY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_RUN_ONLY_FIELD_NUMBER

        public static final int CURRENT_RUN_ONLY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESET_REAPPLY_EXCLUDE_TYPES_FIELD_NUMBER

        public static final int RESET_REAPPLY_EXCLUDE_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasFirstWorkflowTask

        public boolean hasFirstWorkflowTask()
         Resets to the first workflow task completed or started event.
        .google.protobuf.Empty first_workflow_task = 1;
        Specified by:
        hasFirstWorkflowTask in interface ResetOptionsOrBuilder
        Returns:
        Whether the firstWorkflowTask field is set.

      • getFirstWorkflowTask

        public com.google.protobuf.Empty getFirstWorkflowTask()
         Resets to the first workflow task completed or started event.
        .google.protobuf.Empty first_workflow_task = 1;
        Specified by:
        getFirstWorkflowTask in interface ResetOptionsOrBuilder
        Returns:
        The firstWorkflowTask.

      • getFirstWorkflowTaskOrBuilder

        public com.google.protobuf.EmptyOrBuilder getFirstWorkflowTaskOrBuilder()
         Resets to the first workflow task completed or started event.
        .google.protobuf.Empty first_workflow_task = 1;
        Specified by:
        getFirstWorkflowTaskOrBuilder in interface ResetOptionsOrBuilder

      • hasLastWorkflowTask

        public boolean hasLastWorkflowTask()
         Resets to the last workflow task completed or started event.
        .google.protobuf.Empty last_workflow_task = 2;
        Specified by:
        hasLastWorkflowTask in interface ResetOptionsOrBuilder
        Returns:
        Whether the lastWorkflowTask field is set.

      • getLastWorkflowTask

        public com.google.protobuf.Empty getLastWorkflowTask()
         Resets to the last workflow task completed or started event.
        .google.protobuf.Empty last_workflow_task = 2;
        Specified by:
        getLastWorkflowTask in interface ResetOptionsOrBuilder
        Returns:
        The lastWorkflowTask.

      • getLastWorkflowTaskOrBuilder

        public com.google.protobuf.EmptyOrBuilder getLastWorkflowTaskOrBuilder()
         Resets to the last workflow task completed or started event.
        .google.protobuf.Empty last_workflow_task = 2;
        Specified by:
        getLastWorkflowTaskOrBuilder in interface ResetOptionsOrBuilder

      • hasWorkflowTaskId

        public boolean hasWorkflowTaskId()
         The id of a specific `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or
 `WORKFLOW_TASK_STARTED` event to reset to.
 Note that this option doesn't make sense when used as part of a batch request.
        int64 workflow_task_id = 3;
        Specified by:
        hasWorkflowTaskId in interface ResetOptionsOrBuilder
        Returns:
        Whether the workflowTaskId field is set.

      • getWorkflowTaskId

        public long getWorkflowTaskId()
         The id of a specific `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or
 `WORKFLOW_TASK_STARTED` event to reset to.
 Note that this option doesn't make sense when used as part of a batch request.
        int64 workflow_task_id = 3;
        Specified by:
        getWorkflowTaskId in interface ResetOptionsOrBuilder
        Returns:
        The workflowTaskId.

      • hasBuildId

        public boolean hasBuildId()
         Resets to the first workflow task processed by this build id.
 If the workflow was not processed by the build id, or the workflow task can't be
 determined, no reset will be performed.
 Note that by default, this reset is allowed to be to a prior run in a chain of
 continue-as-new.
        string build_id = 4;
        Specified by:
        hasBuildId in interface ResetOptionsOrBuilder
        Returns:
        Whether the buildId field is set.

      • getBuildId

        public java.lang.String getBuildId()
         Resets to the first workflow task processed by this build id.
 If the workflow was not processed by the build id, or the workflow task can't be
 determined, no reset will be performed.
 Note that by default, this reset is allowed to be to a prior run in a chain of
 continue-as-new.
        string build_id = 4;
        Specified by:
        getBuildId in interface ResetOptionsOrBuilder
        Returns:
        The buildId.

      • getBuildIdBytes

        public com.google.protobuf.ByteString getBuildIdBytes()
         Resets to the first workflow task processed by this build id.
 If the workflow was not processed by the build id, or the workflow task can't be
 determined, no reset will be performed.
 Note that by default, this reset is allowed to be to a prior run in a chain of
 continue-as-new.
        string build_id = 4;
        Specified by:
        getBuildIdBytes in interface ResetOptionsOrBuilder
        Returns:
        The bytes for buildId.

      • getResetReapplyTypeValue

        @Deprecated
public int getResetReapplyTypeValue()
        Deprecated.
        temporal.api.common.v1.ResetOptions.reset_reapply_type is deprecated. See temporal/api/common/v1/message.proto;l=158
         Deprecated. Use `options`.
 Default: RESET_REAPPLY_TYPE_SIGNAL
        .temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 10 [deprecated = true];
        Specified by:
        getResetReapplyTypeValue in interface ResetOptionsOrBuilder
        Returns:
        The enum numeric value on the wire for resetReapplyType.

      • getResetReapplyType

        @Deprecated
public ResetReapplyType getResetReapplyType()
        Deprecated.
        temporal.api.common.v1.ResetOptions.reset_reapply_type is deprecated. See temporal/api/common/v1/message.proto;l=158
         Deprecated. Use `options`.
 Default: RESET_REAPPLY_TYPE_SIGNAL
        .temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 10 [deprecated = true];
        Specified by:
        getResetReapplyType in interface ResetOptionsOrBuilder
        Returns:
        The resetReapplyType.

      • getCurrentRunOnly

        public boolean getCurrentRunOnly()
         If true, limit the reset to only within the current run. (Applies to build_id targets and
 possibly others in the future.)
        bool current_run_only = 11;
        Specified by:
        getCurrentRunOnly in interface ResetOptionsOrBuilder
        Returns:
        The currentRunOnly.

      • getResetReapplyExcludeTypesList

        public java.util.List<ResetReapplyExcludeType> getResetReapplyExcludeTypesList()
         Event types not to be reapplied
        repeated .temporal.api.enums.v1.ResetReapplyExcludeType reset_reapply_exclude_types = 12;
        Specified by:
        getResetReapplyExcludeTypesList in interface ResetOptionsOrBuilder
        Returns:
        A list containing the resetReapplyExcludeTypes.

      • getResetReapplyExcludeTypesCount

        public int getResetReapplyExcludeTypesCount()
         Event types not to be reapplied
        repeated .temporal.api.enums.v1.ResetReapplyExcludeType reset_reapply_exclude_types = 12;
        Specified by:
        getResetReapplyExcludeTypesCount in interface ResetOptionsOrBuilder
        Returns:
        The count of resetReapplyExcludeTypes.

      • getResetReapplyExcludeTypes

        public ResetReapplyExcludeType getResetReapplyExcludeTypes​(int index)
         Event types not to be reapplied
        repeated .temporal.api.enums.v1.ResetReapplyExcludeType reset_reapply_exclude_types = 12;
        Specified by:
        getResetReapplyExcludeTypes in interface ResetOptionsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The resetReapplyExcludeTypes at the given index.

      • getResetReapplyExcludeTypesValueList

        public java.util.List<java.lang.Integer> getResetReapplyExcludeTypesValueList()
         Event types not to be reapplied
        repeated .temporal.api.enums.v1.ResetReapplyExcludeType reset_reapply_exclude_types = 12;
        Specified by:
        getResetReapplyExcludeTypesValueList in interface ResetOptionsOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for resetReapplyExcludeTypes.

      • getResetReapplyExcludeTypesValue

        public int getResetReapplyExcludeTypesValue​(int index)
         Event types not to be reapplied
        repeated .temporal.api.enums.v1.ResetReapplyExcludeType reset_reapply_exclude_types = 12;
        Specified by:
        getResetReapplyExcludeTypesValue in interface ResetOptionsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of resetReapplyExcludeTypes at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ResetOptions parseFrom​(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResetOptions parseFrom​(java.nio.ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResetOptions parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResetOptions parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResetOptions parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResetOptions parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResetOptions parseFrom​(java.io.InputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ResetOptions parseFrom​(java.io.InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ResetOptions parseDelimitedFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ResetOptions parseDelimitedFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ResetOptions parseFrom​(com.google.protobuf.CodedInputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ResetOptions parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public ResetOptions.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ResetOptions.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ResetOptions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ResetOptions getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ResetOptions> parser()

      • getParserForType

        public com.google.protobuf.Parser<ResetOptions> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ResetOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder