Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<ParallelismConfigurationDescription.Builder,ParallelismConfigurationDescription>
      Returns:
      a builder for type T

    • 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)
      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.