Package software.amazon.awssdk.services.kinesisanalyticsv2.model

Class ParallelismConfigurationUpdate

java.lang.Object
software.amazon.awssdk.services.kinesisanalyticsv2.model.ParallelismConfigurationUpdate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParallelismConfigurationUpdate.Builder,ParallelismConfigurationUpdate>
@Generated("software.amazon.awssdk:codegen") public final class ParallelismConfigurationUpdate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParallelismConfigurationUpdate.Builder,ParallelismConfigurationUpdate>

Describes updates to parameters for how an application executes multiple tasks simultaneously.

See Also:

  • Method Details

    • configurationTypeUpdate

      public final ConfigurationType configurationTypeUpdate()

      Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. 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, configurationTypeUpdate will return ConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeUpdateAsString().

      Returns:
      Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
      See Also:

    • configurationTypeUpdateAsString

      public final String configurationTypeUpdateAsString()

      Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. 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, configurationTypeUpdate will return ConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeUpdateAsString().

      Returns:
      Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
      See Also:

    • parallelismUpdate

      public final Integer parallelismUpdate()

      Describes updates to the initial number of parallel tasks an 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 will reduce CurrentParallelism down to the Parallelism setting.

      Returns:
      Describes updates to the initial number of parallel tasks an 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 will reduce CurrentParallelism down to the Parallelism setting.

    • parallelismPerKPUUpdate

      public final Integer parallelismPerKPUUpdate()

      Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.

      Returns:
      Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.

    • autoScalingEnabledUpdate

      public final Boolean autoScalingEnabledUpdate()

      Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of a Flink-based Kinesis Data Analytics application in response to increased throughput.

      Returns:
      Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of a Flink-based Kinesis Data Analytics application in response to increased throughput.

    • toBuilder

      public ParallelismConfigurationUpdate.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<ParallelismConfigurationUpdate.Builder,ParallelismConfigurationUpdate>
      Returns:
      a builder for type T

    • builder

      public static ParallelismConfigurationUpdate.Builder builder()

    • serializableBuilderClass

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