/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace KinesisAnalyticsV2 { namespace Model { /** *

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.

*/ class CheckpointConfiguration { public: AWS_KINESISANALYTICSV2_API CheckpointConfiguration(); AWS_KINESISANALYTICSV2_API CheckpointConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_KINESISANALYTICSV2_API CheckpointConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_KINESISANALYTICSV2_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

Describes whether the application uses Kinesis Data Analytics' 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

*/ inline const ConfigurationType& GetConfigurationType() const{ return m_configurationType; } /** *

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

*/ inline bool ConfigurationTypeHasBeenSet() const { return m_configurationTypeHasBeenSet; } /** *

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

*/ inline void SetConfigurationType(const ConfigurationType& value) { m_configurationTypeHasBeenSet = true; m_configurationType = value; } /** *

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

*/ inline void SetConfigurationType(ConfigurationType&& value) { m_configurationTypeHasBeenSet = true; m_configurationType = std::move(value); } /** *

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

*/ inline CheckpointConfiguration& WithConfigurationType(const ConfigurationType& value) { SetConfigurationType(value); return *this;} /** *

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

*/ inline CheckpointConfiguration& WithConfigurationType(ConfigurationType&& value) { SetConfigurationType(std::move(value)); return *this;} /** *

Describes whether checkpointing is enabled for a Flink-based Kinesis Data * Analytics 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.

*/ inline bool GetCheckpointingEnabled() const{ return m_checkpointingEnabled; } /** *

Describes whether checkpointing is enabled for a Flink-based Kinesis Data * Analytics application.

*/ inline bool CheckpointingEnabledHasBeenSet() const { return m_checkpointingEnabledHasBeenSet; } /** *

Describes whether checkpointing is enabled for a Flink-based Kinesis Data * Analytics application.

*/ inline void SetCheckpointingEnabled(bool value) { m_checkpointingEnabledHasBeenSet = true; m_checkpointingEnabled = value; } /** *

Describes whether checkpointing is enabled for a Flink-based Kinesis Data * Analytics application.

*/ inline CheckpointConfiguration& WithCheckpointingEnabled(bool value) { SetCheckpointingEnabled(value); return *this;} /** *

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.

*/ inline long long GetCheckpointInterval() const{ return m_checkpointInterval; } /** *

Describes the interval in milliseconds between checkpoint operations.

*/ inline bool CheckpointIntervalHasBeenSet() const { return m_checkpointIntervalHasBeenSet; } /** *

Describes the interval in milliseconds between checkpoint operations.

*/ inline void SetCheckpointInterval(long long value) { m_checkpointIntervalHasBeenSet = true; m_checkpointInterval = value; } /** *

Describes the interval in milliseconds between checkpoint operations.

*/ inline CheckpointConfiguration& WithCheckpointInterval(long long value) { SetCheckpointInterval(value); return *this;} /** *

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.

* */ inline long long GetMinPauseBetweenCheckpoints() const{ return m_minPauseBetweenCheckpoints; } /** *

* */ inline bool MinPauseBetweenCheckpointsHasBeenSet() const { return m_minPauseBetweenCheckpointsHasBeenSet; } /** *

* */ inline void SetMinPauseBetweenCheckpoints(long long value) { m_minPauseBetweenCheckpointsHasBeenSet = true; m_minPauseBetweenCheckpoints = value; } /** *

* */ inline CheckpointConfiguration& WithMinPauseBetweenCheckpoints(long long value) { SetMinPauseBetweenCheckpoints(value); return *this;} private: ConfigurationType m_configurationType; bool m_configurationTypeHasBeenSet = false; bool m_checkpointingEnabled; bool m_checkpointingEnabledHasBeenSet = false; long long m_checkpointInterval; bool m_checkpointIntervalHasBeenSet = false; long long m_minPauseBetweenCheckpoints; bool m_minPauseBetweenCheckpointsHasBeenSet = false; }; } // namespace Model } // namespace KinesisAnalyticsV2 } // namespace Aws

See Also: