Package io.temporal.api.schedule.v1

Class SchedulePolicies

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SchedulePoliciesOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:SchedulePolicies.java.pb.meta")
public final class SchedulePolicies
extends com.google.protobuf.GeneratedMessageV3
implements SchedulePoliciesOrBuilder
    Protobuf type temporal.api.schedule.v1.SchedulePolicies
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SchedulePolicies.Builder
      Protobuf type temporal.api.schedule.v1.SchedulePolicies

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int CATCHUP_WINDOW_FIELD_NUMBER  
      static int OVERLAP_POLICY_FIELD_NUMBER  
      static int PAUSE_ON_FAILURE_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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      com.google.protobuf.Duration getCatchupWindow()
      Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
      com.google.protobuf.DurationOrBuilder getCatchupWindowOrBuilder()
      Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
      static SchedulePolicies getDefaultInstance()  
      SchedulePolicies getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      ScheduleOverlapPolicy getOverlapPolicy()
      Policy for overlaps.
      int getOverlapPolicyValue()
      Policy for overlaps.
      com.google.protobuf.Parser<SchedulePolicies> getParserForType()  
      boolean getPauseOnFailure()
      If true, and a workflow run fails or times out, turn on "paused".
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasCatchupWindow()
      Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static SchedulePolicies.Builder newBuilder()  
      static SchedulePolicies.Builder newBuilder​(SchedulePolicies prototype)  
      SchedulePolicies.Builder newBuilderForType()  
      protected SchedulePolicies.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static SchedulePolicies parseDelimitedFrom​(java.io.InputStream input)  
      static SchedulePolicies parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SchedulePolicies parseFrom​(byte[] data)  
      static SchedulePolicies parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SchedulePolicies parseFrom​(com.google.protobuf.ByteString data)  
      static SchedulePolicies parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SchedulePolicies parseFrom​(com.google.protobuf.CodedInputStream input)  
      static SchedulePolicies parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SchedulePolicies parseFrom​(java.io.InputStream input)  
      static SchedulePolicies parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SchedulePolicies parseFrom​(java.nio.ByteBuffer data)  
      static SchedulePolicies parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<SchedulePolicies> parser()  
      SchedulePolicies.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

    • Field Detail

      • OVERLAP_POLICY_FIELD_NUMBER

        public static final int OVERLAP_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CATCHUP_WINDOW_FIELD_NUMBER

        public static final int CATCHUP_WINDOW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PAUSE_ON_FAILURE_FIELD_NUMBER

        public static final int PAUSE_ON_FAILURE_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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getOverlapPolicyValue

        public int getOverlapPolicyValue()
         Policy for overlaps.
 Note that this can be changed after a schedule has taken some actions,
 and some changes might produce unintuitive results. In general, the later
 policy overrides the earlier policy.
        .temporal.api.enums.v1.ScheduleOverlapPolicy overlap_policy = 1;
        Specified by:
        getOverlapPolicyValue in interface SchedulePoliciesOrBuilder
        Returns:
        The enum numeric value on the wire for overlapPolicy.

      • getOverlapPolicy

        public ScheduleOverlapPolicy getOverlapPolicy()
         Policy for overlaps.
 Note that this can be changed after a schedule has taken some actions,
 and some changes might produce unintuitive results. In general, the later
 policy overrides the earlier policy.
        .temporal.api.enums.v1.ScheduleOverlapPolicy overlap_policy = 1;
        Specified by:
        getOverlapPolicy in interface SchedulePoliciesOrBuilder
        Returns:
        The overlapPolicy.

      • hasCatchupWindow

        public boolean hasCatchupWindow()
         Policy for catchups:
 If the Temporal server misses an action due to one or more components
 being down, and comes back up, the action will be run if the scheduled
 time is within this window from the current time.
 This value defaults to 60 seconds, and can't be less than 10 seconds.
        .google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];
        Specified by:
        hasCatchupWindow in interface SchedulePoliciesOrBuilder
        Returns:
        Whether the catchupWindow field is set.

      • getCatchupWindow

        public com.google.protobuf.Duration getCatchupWindow()
         Policy for catchups:
 If the Temporal server misses an action due to one or more components
 being down, and comes back up, the action will be run if the scheduled
 time is within this window from the current time.
 This value defaults to 60 seconds, and can't be less than 10 seconds.
        .google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];
        Specified by:
        getCatchupWindow in interface SchedulePoliciesOrBuilder
        Returns:
        The catchupWindow.

      • getCatchupWindowOrBuilder

        public com.google.protobuf.DurationOrBuilder getCatchupWindowOrBuilder()
         Policy for catchups:
 If the Temporal server misses an action due to one or more components
 being down, and comes back up, the action will be run if the scheduled
 time is within this window from the current time.
 This value defaults to 60 seconds, and can't be less than 10 seconds.
        .google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];
        Specified by:
        getCatchupWindowOrBuilder in interface SchedulePoliciesOrBuilder

      • getPauseOnFailure

        public boolean getPauseOnFailure()
         If true, and a workflow run fails or times out, turn on "paused".
 This applies after retry policies: the full chain of retries must fail to
 trigger a pause here.
        bool pause_on_failure = 3;
        Specified by:
        getPauseOnFailure in interface SchedulePoliciesOrBuilder
        Returns:
        The pauseOnFailure.

      • 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 SchedulePolicies parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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