com.amazonaws.services.kinesisanalyticsv2.model

Class CheckpointConfiguration

java.lang.Object

com.amazonaws.services.kinesisanalyticsv2.model.CheckpointConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CheckpointConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CheckpointConfiguration()

Method Summary

Modifier and Type	Method and Description
CheckpointConfiguration	clone()
boolean	equals(Object obj)
Boolean	getCheckpointingEnabled() Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
Long	getCheckpointInterval() Describes the interval in milliseconds between checkpoint operations.
String	getConfigurationType() Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior.
Long	getMinPauseBetweenCheckpoints() Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
int	hashCode()
Boolean	isCheckpointingEnabled() Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCheckpointingEnabled(Boolean checkpointingEnabled) Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
void	setCheckpointInterval(Long checkpointInterval) Describes the interval in milliseconds between checkpoint operations.
void	setConfigurationType(String configurationType) Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior.
void	setMinPauseBetweenCheckpoints(Long minPauseBetweenCheckpoints) Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
String	toString() Returns a string representation of this object.
CheckpointConfiguration	withCheckpointingEnabled(Boolean checkpointingEnabled) Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
CheckpointConfiguration	withCheckpointInterval(Long checkpointInterval) Describes the interval in milliseconds between checkpoint operations.
CheckpointConfiguration	withConfigurationType(ConfigurationType configurationType) Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior.
CheckpointConfiguration	withConfigurationType(String configurationType) Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior.
CheckpointConfiguration	withMinPauseBetweenCheckpoints(Long minPauseBetweenCheckpoints) Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckpointConfiguration

public CheckpointConfiguration()

Method Detail

setConfigurationType

public void setConfigurationType(String configurationType)

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

Parameters:

configurationType - 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

See Also:

ConfigurationType

getConfigurationType

public String getConfigurationType()

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

Returns:

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

See Also:

ConfigurationType

withConfigurationType

public CheckpointConfiguration withConfigurationType(String configurationType)

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

Parameters:

configurationType - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigurationType

withConfigurationType

public CheckpointConfiguration withConfigurationType(ConfigurationType configurationType)

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

Parameters:

configurationType - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigurationType

setCheckpointingEnabled

public void setCheckpointingEnabled(Boolean checkpointingEnabled)

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.

Parameters:

checkpointingEnabled - 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.

getCheckpointingEnabled

public Boolean getCheckpointingEnabled()

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.

Returns:

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.

withCheckpointingEnabled

public CheckpointConfiguration withCheckpointingEnabled(Boolean checkpointingEnabled)

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.

Parameters:

checkpointingEnabled - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isCheckpointingEnabled

public Boolean isCheckpointingEnabled()

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.

Returns:

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.

setCheckpointInterval

public void setCheckpointInterval(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.

Parameters:

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.

getCheckpointInterval

public Long getCheckpointInterval()

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.

withCheckpointInterval

public CheckpointConfiguration withCheckpointInterval(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMinPauseBetweenCheckpoints

public void setMinPauseBetweenCheckpoints(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.

Parameters:

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.

getMinPauseBetweenCheckpoints

public Long getMinPauseBetweenCheckpoints()

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.

withMinPauseBetweenCheckpoints

public CheckpointConfiguration withMinPauseBetweenCheckpoints(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CheckpointConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.