Class TimeSkippingConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.workflow.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
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- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic final classConfiguration for time skipping during a workflow 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic TimeSkippingConfigstatic final com.google.protobuf.Descriptors.DescriptorbooleanEnables or disables time skipping for this workflow execution.com.google.protobuf.DurationMaximum elapsed time since time skipping was enabled.com.google.protobuf.DurationOrBuilderMaximum elapsed time since time skipping was enabled.com.google.protobuf.DurationMaximum total virtual time that can be skipped.com.google.protobuf.DurationOrBuilderMaximum total virtual time that can be skipped.com.google.protobuf.Parser<TimeSkippingConfig> intinthashCode()booleanMaximum elapsed time since time skipping was enabled.booleanMaximum total virtual time that can be skipped.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic TimeSkippingConfig.Builderstatic TimeSkippingConfig.BuildernewBuilder(TimeSkippingConfig prototype) protected TimeSkippingConfig.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static TimeSkippingConfigparseDelimitedFrom(InputStream input) static TimeSkippingConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TimeSkippingConfigparseFrom(byte[] data) static TimeSkippingConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TimeSkippingConfigparseFrom(com.google.protobuf.ByteString data) static TimeSkippingConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TimeSkippingConfigparseFrom(com.google.protobuf.CodedInputStream input) static TimeSkippingConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TimeSkippingConfigparseFrom(InputStream input) static TimeSkippingConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TimeSkippingConfigparseFrom(ByteBuffer data) static TimeSkippingConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TimeSkippingConfig> parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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:
-
MAX_SKIPPED_DURATION_FIELD_NUMBER
public static final int MAX_SKIPPED_DURATION_FIELD_NUMBER- See Also:
-
MAX_ELAPSED_DURATION_FIELD_NUMBER
public static final int MAX_ELAPSED_DURATION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getBoundCase
- Specified by:
getBoundCasein interfaceTimeSkippingConfigOrBuilder
-
getEnabled
public boolean getEnabled()Enables or disables time skipping for this workflow execution.
bool enabled = 1;- Specified by:
getEnabledin interfaceTimeSkippingConfigOrBuilder- Returns:
- The enabled.
-
hasMaxSkippedDuration
public boolean hasMaxSkippedDuration()Maximum total virtual time that can be skipped.
.google.protobuf.Duration max_skipped_duration = 4;- Specified by:
hasMaxSkippedDurationin interfaceTimeSkippingConfigOrBuilder- 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:
getMaxSkippedDurationin interfaceTimeSkippingConfigOrBuilder- Returns:
- The maxSkippedDuration.
-
getMaxSkippedDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getMaxSkippedDurationOrBuilder()Maximum total virtual time that can be skipped.
.google.protobuf.Duration max_skipped_duration = 4;- Specified by:
getMaxSkippedDurationOrBuilderin interfaceTimeSkippingConfigOrBuilder
-
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:
hasMaxElapsedDurationin interfaceTimeSkippingConfigOrBuilder- 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:
getMaxElapsedDurationin interfaceTimeSkippingConfigOrBuilder- Returns:
- The maxElapsedDuration.
-
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:
getMaxElapsedDurationOrBuilderin interfaceTimeSkippingConfigOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static TimeSkippingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TimeSkippingConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-