Class CheckpointConfiguration

java.lang.Object
software.amazon.awssdk.services.kinesisanalyticsv2.model.CheckpointConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CheckpointConfiguration.Builder,CheckpointConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class CheckpointConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CheckpointConfiguration.Builder,CheckpointConfiguration>

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

See Also:

  • Method Details

    • configurationType

      public final ConfigurationType configurationType()

      Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

      If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

      • CheckpointingEnabled: true

      • CheckpointInterval: 60000

      • MinPauseBetweenCheckpoints: 5000

      If the service returns an enum value that is not available in the current SDK version, configurationType will return ConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeAsString().

      Returns:
      Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

      If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

      • CheckpointingEnabled: true

      • CheckpointInterval: 60000

      • MinPauseBetweenCheckpoints: 5000

      See Also:

    • configurationTypeAsString

      public final String configurationTypeAsString()

      Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

      If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

      • CheckpointingEnabled: true

      • CheckpointInterval: 60000

      • MinPauseBetweenCheckpoints: 5000

      If the service returns an enum value that is not available in the current SDK version, configurationType will return ConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeAsString().

      Returns:
      Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

      If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

      • CheckpointingEnabled: true

      • CheckpointInterval: 60000

      • MinPauseBetweenCheckpoints: 5000

      See Also:

    • checkpointingEnabled

      public final Boolean checkpointingEnabled()

      Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

      If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.

      Returns:
      Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

      If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.

    • checkpointInterval

      public final Long checkpointInterval()

      Describes the interval in milliseconds between checkpoint operations.

      If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

      Returns:
      Describes the interval in milliseconds between checkpoint operations.

      If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

    • minPauseBetweenCheckpoints

      public final Long minPauseBetweenCheckpoints()

      Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

      If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

      Returns:
      Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

      If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

    • toBuilder

      public CheckpointConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CheckpointConfiguration.Builder,CheckpointConfiguration>
      Returns:
      a builder for type T

    • builder

      public static CheckpointConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CheckpointConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.