Package software.amazon.awssdk.services.kinesisanalyticsv2.model

Class CheckpointConfigurationUpdate

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

Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.

See Also:

  • Method Details

    • configurationTypeUpdate

      public final ConfigurationType configurationTypeUpdate()

      Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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, configurationTypeUpdate will return ConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeUpdateAsString().

      Returns:
      Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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:

    • configurationTypeUpdateAsString

      public final String configurationTypeUpdateAsString()

      Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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, configurationTypeUpdate will return ConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeUpdateAsString().

      Returns:
      Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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:

    • checkpointingEnabledUpdate

      public final Boolean checkpointingEnabledUpdate()

      Describes updates to whether checkpointing is enabled for an 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 updates to whether checkpointing is enabled for an 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.

    • checkpointIntervalUpdate

      public final Long checkpointIntervalUpdate()

      Describes updates to 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 updates to 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.

    • minPauseBetweenCheckpointsUpdate

      public final Long minPauseBetweenCheckpointsUpdate()

      Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

      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 updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

      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 CheckpointConfigurationUpdate.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<CheckpointConfigurationUpdate.Builder,CheckpointConfigurationUpdate>
      Returns:
      a builder for type T

    • builder

      public static CheckpointConfigurationUpdate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CheckpointConfigurationUpdate.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.