software.amazon.awssdk.services.kinesisanalyticsv2.model

Class ParallelismConfigurationDescription

java.lang.Object

software.amazon.awssdk.services.kinesisanalyticsv2.model.ParallelismConfigurationDescription

All Implemented Interfaces:

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

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

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParallelismConfigurationDescription.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 ParallelismConfigurationDescription.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.
Integer	currentParallelism() Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform.
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 ParallelismConfigurationDescription.Builder>	serializableBuilderClass()
ParallelismConfigurationDescription.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.

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.

See Also:

ConfigurationType

configurationTypeAsString

public final String configurationTypeAsString()

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

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.

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, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism 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, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism 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.

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.

currentParallelism

public final Integer currentParallelism()

Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this 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 current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this 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.

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 ParallelismConfigurationDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParallelismConfigurationDescription.Builder,ParallelismConfigurationDescription>

builder

public static ParallelismConfigurationDescription.Builder builder()

serializableBuilderClass

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