Class TimeSkippingConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<TimeSkippingConfig.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>
io.temporal.api.workflow.v1.TimeSkippingConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TimeSkippingConfigOrBuilder, Cloneable
Enclosing class:
TimeSkippingConfig
public static final class TimeSkippingConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder> implements TimeSkippingConfigOrBuilder
 Configuration for time skipping during a workflow execution.
 When enabled, virtual time advances automatically whenever there is no in-flight work.
 In-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations,
 and possibly other features added in the future.
 User timers are not classified as in-flight work and will be skipped over.
 When time advances, it skips to the earlier of the next user timer or the configured bound, if either exists.
 
 Propagation behavior of time skipping:
 The enabled flag, bound fields, and accumulated skipped duration are propagated to related executions as follows:
 (1) Child workflows and continue-as-new: both the configuration and the accumulated skipped duration are
     inherited from the current execution. The configured bound is shared between the inherited skipped
     duration and any additional duration skipped by the new run.
 (2) Retry and cron: the configuration and accumulated skipped duration are inherited as recorded when the
     current workflow started; the accumulated skipped duration of the current run is not propagated.
 (3) Reset: the new run retains the time-skipping configuration of the current execution. Because reset replays
     all events up to the reset point and re-applies any UpdateWorkflowExecutionOptions changes made after that
     point, the resulting run ends up with the same final time-skipping configuration as the previous run.
Protobuf type temporal.api.workflow.v1.TimeSkippingConfig

  • Method Details

    • 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.Builder<TimeSkippingConfig.Builder>

    • clear

      public TimeSkippingConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public TimeSkippingConfig.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • setField

      public TimeSkippingConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • clearField

      public TimeSkippingConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • clearOneof

      public TimeSkippingConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • setRepeatedField

      public TimeSkippingConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • addRepeatedField

      public TimeSkippingConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • mergeFrom

      public TimeSkippingConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TimeSkippingConfig.Builder>

    • mergeFrom

      public TimeSkippingConfig.Builder mergeFrom(TimeSkippingConfig other)

    • isInitialized

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

    • mergeFrom

      public TimeSkippingConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TimeSkippingConfig.Builder>
      Throws:
      IOException

    • getBoundCase

      public TimeSkippingConfig.BoundCase getBoundCase()
      Specified by:
      getBoundCase in interface TimeSkippingConfigOrBuilder

    • clearBound

      public TimeSkippingConfig.Builder clearBound()

    • 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.

    • setEnabled

      public TimeSkippingConfig.Builder setEnabled(boolean value)
       Enables or disables time skipping for this workflow execution.
      bool enabled = 1;
      Parameters:
      value - The enabled to set.
      Returns:
      This builder for chaining.

    • clearEnabled

      public TimeSkippingConfig.Builder clearEnabled()
       Enables or disables time skipping for this workflow execution.
      bool enabled = 1;
      Returns:
      This builder for chaining.

    • hasMaxSkippedDuration

      public boolean hasMaxSkippedDuration()
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;
      Specified by:
      hasMaxSkippedDuration in interface TimeSkippingConfigOrBuilder
      Returns:
      Whether the maxSkippedDuration field is set.

    • getMaxSkippedDuration

      public com.google.protobuf.Duration getMaxSkippedDuration()
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;
      Specified by:
      getMaxSkippedDuration in interface TimeSkippingConfigOrBuilder
      Returns:
      The maxSkippedDuration.

    • setMaxSkippedDuration

      public TimeSkippingConfig.Builder setMaxSkippedDuration(com.google.protobuf.Duration value)
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;

    • setMaxSkippedDuration

      public TimeSkippingConfig.Builder setMaxSkippedDuration(com.google.protobuf.Duration.Builder builderForValue)
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;

    • mergeMaxSkippedDuration

      public TimeSkippingConfig.Builder mergeMaxSkippedDuration(com.google.protobuf.Duration value)
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;

    • clearMaxSkippedDuration

      public TimeSkippingConfig.Builder clearMaxSkippedDuration()
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;

    • getMaxSkippedDurationBuilder

      public com.google.protobuf.Duration.Builder getMaxSkippedDurationBuilder()
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;

    • getMaxSkippedDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxSkippedDurationOrBuilder()
       Maximum total virtual time that can be skipped.
      .google.protobuf.Duration max_skipped_duration = 4;
      Specified by:
      getMaxSkippedDurationOrBuilder in interface TimeSkippingConfigOrBuilder

    • hasMaxElapsedDuration

      public boolean hasMaxElapsedDuration()
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;
      Specified by:
      hasMaxElapsedDuration in interface TimeSkippingConfigOrBuilder
      Returns:
      Whether the maxElapsedDuration field is set.

    • getMaxElapsedDuration

      public com.google.protobuf.Duration getMaxElapsedDuration()
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;
      Specified by:
      getMaxElapsedDuration in interface TimeSkippingConfigOrBuilder
      Returns:
      The maxElapsedDuration.

    • setMaxElapsedDuration

      public TimeSkippingConfig.Builder setMaxElapsedDuration(com.google.protobuf.Duration value)
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;

    • setMaxElapsedDuration

      public TimeSkippingConfig.Builder setMaxElapsedDuration(com.google.protobuf.Duration.Builder builderForValue)
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;

    • mergeMaxElapsedDuration

      public TimeSkippingConfig.Builder mergeMaxElapsedDuration(com.google.protobuf.Duration value)
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;

    • clearMaxElapsedDuration

      public TimeSkippingConfig.Builder clearMaxElapsedDuration()
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;

    • getMaxElapsedDurationBuilder

      public com.google.protobuf.Duration.Builder getMaxElapsedDurationBuilder()
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;

    • getMaxElapsedDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxElapsedDurationOrBuilder()
       Maximum elapsed time since time skipping was enabled.
 This includes both skipped time and real time elapsing.
 (-- api-linter: core::0142::time-field-names=disabled --)
      .google.protobuf.Duration max_elapsed_duration = 5;
      Specified by:
      getMaxElapsedDurationOrBuilder in interface TimeSkippingConfigOrBuilder

    • setUnknownFields

      public final TimeSkippingConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>

    • mergeUnknownFields

      public final TimeSkippingConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TimeSkippingConfig.Builder>