Package software.amazon.awssdk.services.rds.model

Class DescribeOrderableDbInstanceOptionsRequest

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

  • Method Details

    • engine

      public final String engine()

      The name of the database engine to describe DB instance options for.

      Valid Values:

      • aurora-mysql

      • aurora-postgresql

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

      Returns:
      The name of the database engine to describe DB instance options for.

      Valid Values:

      • aurora-mysql

      • aurora-postgresql

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • engineVersion

      public final String engineVersion()

      A filter to include only the available options for the specified engine version.

      Returns:
      A filter to include only the available options for the specified engine version.

    • dbInstanceClass

      public final String dbInstanceClass()

      A filter to include only the available options for the specified DB instance class.

      Returns:
      A filter to include only the available options for the specified DB instance class.

    • licenseModel

      public final String licenseModel()

      A filter to include only the available options for the specified license model.

      RDS Custom supports only the BYOL licensing model.

      Returns:
      A filter to include only the available options for the specified license model.

      RDS Custom supports only the BYOL licensing model.

    • availabilityZoneGroup

      public final String availabilityZoneGroup()

      The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

      Omit this parameter to show the available options in the specified Amazon Web Services Region.

      This setting doesn't apply to RDS Custom DB instances.

      Returns:
      The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

      Omit this parameter to show the available options in the specified Amazon Web Services Region.

      This setting doesn't apply to RDS Custom DB instances.

    • vpc

      public final Boolean vpc()

      Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

      RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

      Returns:
      Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

      RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filters

      public final List<Filter> filters()

      This parameter isn't currently supported.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

      Returns:
      This parameter isn't currently supported.

    • maxRecords

      public final Integer maxRecords()

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 1000.

      Returns:
      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 1000.

    • marker

      public final String marker()

      An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Returns:
      An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • toBuilder

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

    • builder

      public static DescribeOrderableDbInstanceOptionsRequest.Builder builder()

    • serializableBuilderClass

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