software.amazon.awssdk.services.kinesisanalyticsv2.model

Class ParallelismConfiguration

java.lang.Object

software.amazon.awssdk.services.kinesisanalyticsv2.model.ParallelismConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ParallelismConfiguration.Builder,ParallelismConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ParallelismConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParallelismConfiguration.Builder,ParallelismConfiguration>

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParallelismConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	autoScalingEnabled() Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
static ParallelismConfiguration.Builder	builder()
ConfigurationType	configurationType() Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
String	configurationTypeAsString() Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	parallelism() Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform.
Integer	parallelismPerKPU() Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
List<SdkField<?>>	sdkFields()
static Class<? extends ParallelismConfiguration.Builder>	serializableBuilderClass()
ParallelismConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

configurationType

public final ConfigurationType configurationType()

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

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 the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

See Also:

ConfigurationType

configurationTypeAsString

public final String configurationTypeAsString()

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

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 the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

See Also:

ConfigurationType

parallelism

public final Integer parallelism()

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

Returns:

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

parallelismPerKPU

public final Integer parallelismPerKPU()

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

Returns:

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

autoScalingEnabled

public final Boolean autoScalingEnabled()

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

Returns:

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

toBuilder

public ParallelismConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParallelismConfiguration.Builder,ParallelismConfiguration>

builder

public static ParallelismConfiguration.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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