Package software.amazon.awssdk.services.opensearch.model

Class DescribeInstanceTypeLimitsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.opensearch.model.OpenSearchRequest
software.amazon.awssdk.services.opensearch.model.DescribeInstanceTypeLimitsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeInstanceTypeLimitsRequest.Builder,DescribeInstanceTypeLimitsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInstanceTypeLimitsRequest extends OpenSearchRequest implements ToCopyableBuilder<DescribeInstanceTypeLimitsRequest.Builder,DescribeInstanceTypeLimitsRequest>

Container for the parameters to the DescribeInstanceTypeLimits operation.

  • Method Details

    • domainName

      public final String domainName()

      The name of the domain. Only specify if you need the limits for an existing domain.

      Returns:
      The name of the domain. Only specify if you need the limits for an existing domain.

    • instanceType

      public final OpenSearchPartitionInstanceType instanceType()

      The OpenSearch Service instance type for which you need limit information.

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

      Returns:
      The OpenSearch Service instance type for which you need limit information.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The OpenSearch Service instance type for which you need limit information.

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

      Returns:
      The OpenSearch Service instance type for which you need limit information.
      See Also:

    • engineVersion

      public final String engineVersion()

      Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

      Returns:
      Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

    • toBuilder

      public DescribeInstanceTypeLimitsRequest.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<DescribeInstanceTypeLimitsRequest.Builder,DescribeInstanceTypeLimitsRequest>
      Specified by:
      toBuilder in class OpenSearchRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeInstanceTypeLimitsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeInstanceTypeLimitsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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