Class TimeSkippingConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.common.v1.TimeSkippingConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TimeSkippingConfigOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:TimeSkippingConfig.java.pb.meta") public final class TimeSkippingConfig extends com.google.protobuf.GeneratedMessageV3 implements TimeSkippingConfigOrBuilder
 The configuration for time skipping of an execution.
 When time skipping is enabled, virtual time advances automatically whenever there is no in-flight work.
 Options like fast_forward, disable_propagation, and max_session_skip_count are provided for granular
 control of the execution's time skipping behavior. See each field's comment for a detailed explanation.

 An example of workflows with time skipping:
 For workflows, an execution is a chain of runs including retries, cron, and continue-as-new.
 In-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations, etc.
 User timers are not classified as in-flight work and will be skipped over; the virtual clock may also skip to the
 time point of the registered fast-forward when there is no in-flight work.
 Whenever time is skipped, the skip count is incremented by one; max_session_skip_count bounds the number of skips allowed within a single time-skipping session.
 For child workflows, by default, if the parent execution is skipping time, the child execution will also skip time,
 but a parent's fast_forward won't affect its child's execution. A flag is provided to disable propagation of the
 "enabled" flag to child workflows; regardless of that flag, a child workflow inherits the virtual time from the
 parent execution as its start time.
Protobuf type temporal.api.common.v1.TimeSkippingConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TimeSkippingConfig.Builder
    The configuration for time skipping of an execution.

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DISABLE_PROPAGATION_FIELD_NUMBER
     
    static final int
    ENABLED_FIELD_NUMBER
     
    static final int
    FAST_FORWARD_CONFIG_FIELD_NUMBER
     
    static final int
    MAX_SESSION_SKIP_COUNT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static TimeSkippingConfig
    getDefaultInstance()
     
    TimeSkippingConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisablePropagation()
    By default, executions started by another execution (e.g.
    boolean
    getEnabled()
    Enables or disables time skipping for this workflow execution.
    FastForwardConfig
    getFastForwardConfig()
    An optional opt-in to control time-skipping behavior through fast-forward; see its definition for details.
    FastForwardConfigOrBuilder
    getFastForwardConfigOrBuilder()
    An optional opt-in to control time-skipping behavior through fast-forward; see its definition for details.
    int
    getMaxSessionSkipCount()
    The maximum number of skips allowed every time this field is updated.
    com.google.protobuf.Parser<TimeSkippingConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasFastForwardConfig()
    An optional opt-in to control time-skipping behavior through fast-forward; see its definition for details.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TimeSkippingConfig.Builder
    newBuilder()
     
    static TimeSkippingConfig.Builder
    newBuilder(TimeSkippingConfig prototype)
     
    TimeSkippingConfig.Builder
    newBuilderForType()
     
    protected TimeSkippingConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static TimeSkippingConfig
    parseDelimitedFrom(InputStream input)
     
    static TimeSkippingConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TimeSkippingConfig
    parseFrom(byte[] data)
     
    static TimeSkippingConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TimeSkippingConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static TimeSkippingConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TimeSkippingConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TimeSkippingConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TimeSkippingConfig
    parseFrom(InputStream input)
     
    static TimeSkippingConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TimeSkippingConfig
    parseFrom(ByteBuffer data)
     
    static TimeSkippingConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TimeSkippingConfig>
    parser()
     
    TimeSkippingConfig.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 Details

    • ENABLED_FIELD_NUMBER

      public static final int ENABLED_FIELD_NUMBER
      See Also:

    • FAST_FORWARD_CONFIG_FIELD_NUMBER

      public static final int FAST_FORWARD_CONFIG_FIELD_NUMBER
      See Also:

    • DISABLE_PROPAGATION_FIELD_NUMBER

      public static final int DISABLE_PROPAGATION_FIELD_NUMBER
      See Also:

    • MAX_SESSION_SKIP_COUNT_FIELD_NUMBER

      public static final int MAX_SESSION_SKIP_COUNT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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

    • getEnabled

      public boolean getEnabled()
       Enables or disables time skipping for this workflow execution.
      bool enabled = 1;
      Specified by:
      getEnabled in interface TimeSkippingConfigOrBuilder
      Returns:
      The enabled.

    • hasFastForwardConfig

      public boolean hasFastForwardConfig()
       An optional opt-in to control time-skipping behavior through fast-forward; see its definition for details.
      .temporal.api.common.v1.FastForwardConfig fast_forward_config = 2;
      Specified by:
      hasFastForwardConfig in interface TimeSkippingConfigOrBuilder
      Returns:
      Whether the fastForwardConfig field is set.

    • getFastForwardConfig

      public FastForwardConfig getFastForwardConfig()
       An optional opt-in to control time-skipping behavior through fast-forward; see its definition for details.
      .temporal.api.common.v1.FastForwardConfig fast_forward_config = 2;
      Specified by:
      getFastForwardConfig in interface TimeSkippingConfigOrBuilder
      Returns:
      The fastForwardConfig.

    • getFastForwardConfigOrBuilder

      public FastForwardConfigOrBuilder getFastForwardConfigOrBuilder()
       An optional opt-in to control time-skipping behavior through fast-forward; see its definition for details.
      .temporal.api.common.v1.FastForwardConfig fast_forward_config = 2;
      Specified by:
      getFastForwardConfigOrBuilder in interface TimeSkippingConfigOrBuilder

    • getDisablePropagation

      public boolean getDisablePropagation()
       By default, executions started by another execution (e.g. a child workflow of a parent workflow or
 a schedule with the time-skipping policy enabled) inherit the "enabled" flag and skip time when possible.
 This flag disables that inheritance.
      bool disable_propagation = 3;
      Specified by:
      getDisablePropagation in interface TimeSkippingConfigOrBuilder
      Returns:
      The disablePropagation.

    • getMaxSessionSkipCount

      public int getMaxSessionSkipCount()
       The maximum number of skips allowed every time this field is updated. It protects the execution from
 situations like unlimited retries when backoff is skipped.

 Every time the execution skips time, the skip count is incremented by one, and when it reaches
 max_session_skip_count, time skipping stops. Whenever this config field is updated, the accumulated
 skip count is cleared, marking the start of a new session.
 For an execution with a chain of runs (retry, cron, continue-as-new), the count is accumulated
 across all runs within the same session.

 If this field is not set, the server applies a large default value (e.g. 100). The default can
 be changed through dynamic config, and is overridden by this field when set.
      int32 max_session_skip_count = 4;
      Specified by:
      getMaxSessionSkipCount in interface TimeSkippingConfigOrBuilder
      Returns:
      The maxSessionSkipCount.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 TimeSkippingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TimeSkippingConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TimeSkippingConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TimeSkippingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TimeSkippingConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TimeSkippingConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TimeSkippingConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TimeSkippingConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static TimeSkippingConfig.Builder newBuilder()

    • newBuilder

      public static TimeSkippingConfig.Builder newBuilder(TimeSkippingConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TimeSkippingConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<TimeSkippingConfig> 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 TimeSkippingConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder