Class ScalingParameters

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

The desired instance type and desired number of replicas of each index partition.

See Also:

  • Method Details

    • desiredInstanceType

      public final PartitionInstanceType desiredInstanceType()

      The instance type that you want to preconfigure for your domain. For example, search.m1.small.

      If the service returns an enum value that is not available in the current SDK version, desiredInstanceType will return PartitionInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredInstanceTypeAsString().

      Returns:
      The instance type that you want to preconfigure for your domain. For example, search.m1.small.
      See Also:

    • desiredInstanceTypeAsString

      public final String desiredInstanceTypeAsString()

      The instance type that you want to preconfigure for your domain. For example, search.m1.small.

      If the service returns an enum value that is not available in the current SDK version, desiredInstanceType will return PartitionInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredInstanceTypeAsString().

      Returns:
      The instance type that you want to preconfigure for your domain. For example, search.m1.small.
      See Also:

    • desiredReplicationCount

      public final Integer desiredReplicationCount()

      The number of replicas you want to preconfigure for each index partition.

      Returns:
      The number of replicas you want to preconfigure for each index partition.

    • desiredPartitionCount

      public final Integer desiredPartitionCount()

      The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

      Returns:
      The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

    • toBuilder

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

    • builder

      public static ScalingParameters.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.