software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeOrderableDbInstanceOptionsRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField ENGINE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Engine")
.getter(getter(DescribeOrderableDbInstanceOptionsRequest::engine)).setter(setter(Builder::engine))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Engine").build()).build();
private static final SdkField ENGINE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineVersion").getter(getter(DescribeOrderableDbInstanceOptionsRequest::engineVersion))
.setter(setter(Builder::engineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EngineVersion").build()).build();
private static final SdkField DB_INSTANCE_CLASS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceClass").getter(getter(DescribeOrderableDbInstanceOptionsRequest::dbInstanceClass))
.setter(setter(Builder::dbInstanceClass))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceClass").build()).build();
private static final SdkField LICENSE_MODEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LicenseModel").getter(getter(DescribeOrderableDbInstanceOptionsRequest::licenseModel))
.setter(setter(Builder::licenseModel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LicenseModel").build()).build();
private static final SdkField AVAILABILITY_ZONE_GROUP_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AvailabilityZoneGroup").getter(getter(DescribeOrderableDbInstanceOptionsRequest::availabilityZoneGroup))
.setter(setter(Builder::availabilityZoneGroup))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AvailabilityZoneGroup").build())
.build();
private static final SdkField VPC_FIELD = SdkField. builder(MarshallingType.BOOLEAN).memberName("Vpc")
.getter(getter(DescribeOrderableDbInstanceOptionsRequest::vpc)).setter(setter(Builder::vpc))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Vpc").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeOrderableDbInstanceOptionsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").build()).build()).build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeOrderableDbInstanceOptionsRequest::maxRecords))
.setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeOrderableDbInstanceOptionsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENGINE_FIELD,
ENGINE_VERSION_FIELD, DB_INSTANCE_CLASS_FIELD, LICENSE_MODEL_FIELD, AVAILABILITY_ZONE_GROUP_FIELD, VPC_FIELD,
FILTERS_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD));
private final String engine;
private final String engineVersion;
private final String dbInstanceClass;
private final String licenseModel;
private final String availabilityZoneGroup;
private final Boolean vpc;
private final List filters;
private final Integer maxRecords;
private final String marker;
private DescribeOrderableDbInstanceOptionsRequest(BuilderImpl builder) {
super(builder);
this.engine = builder.engine;
this.engineVersion = builder.engineVersion;
this.dbInstanceClass = builder.dbInstanceClass;
this.licenseModel = builder.licenseModel;
this.availabilityZoneGroup = builder.availabilityZoneGroup;
this.vpc = builder.vpc;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* 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
*
*
*
*
* @return 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
*
*
*/
public final String engine() {
return engine;
}
/**
*
* A filter to include only the available options for the specified engine version.
*
*
* @return A filter to include only the available options for the specified engine version.
*/
public final String engineVersion() {
return engineVersion;
}
/**
*
* A filter to include only the available options for the specified DB instance class.
*
*
* @return A filter to include only the available options for the specified DB instance class.
*/
public final String dbInstanceClass() {
return dbInstanceClass;
}
/**
*
* A filter to include only the available options for the specified license model.
*
*
* RDS Custom supports only the BYOL licensing model.
*
*
* @return A filter to include only the available options for the specified license model.
*
* RDS Custom supports only the BYOL licensing model.
*/
public final String licenseModel() {
return licenseModel;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String availabilityZoneGroup() {
return availabilityZoneGroup;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean vpc() {
return vpc;
}
/**
* 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 {@code 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.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasFilters} method.
*
*
* @return This parameter isn't currently supported.
*/
public final List filters() {
return filters;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* 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
.
*
*
* @return 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
.
*/
public final String marker() {
return marker;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(engine());
hashCode = 31 * hashCode + Objects.hashCode(engineVersion());
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceClass());
hashCode = 31 * hashCode + Objects.hashCode(licenseModel());
hashCode = 31 * hashCode + Objects.hashCode(availabilityZoneGroup());
hashCode = 31 * hashCode + Objects.hashCode(vpc());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeOrderableDbInstanceOptionsRequest)) {
return false;
}
DescribeOrderableDbInstanceOptionsRequest other = (DescribeOrderableDbInstanceOptionsRequest) obj;
return Objects.equals(engine(), other.engine()) && Objects.equals(engineVersion(), other.engineVersion())
&& Objects.equals(dbInstanceClass(), other.dbInstanceClass())
&& Objects.equals(licenseModel(), other.licenseModel())
&& Objects.equals(availabilityZoneGroup(), other.availabilityZoneGroup()) && Objects.equals(vpc(), other.vpc())
&& hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(marker(), other.marker());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeOrderableDbInstanceOptionsRequest").add("Engine", engine())
.add("EngineVersion", engineVersion()).add("DBInstanceClass", dbInstanceClass())
.add("LicenseModel", licenseModel()).add("AvailabilityZoneGroup", availabilityZoneGroup()).add("Vpc", vpc())
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Engine":
return Optional.ofNullable(clazz.cast(engine()));
case "EngineVersion":
return Optional.ofNullable(clazz.cast(engineVersion()));
case "DBInstanceClass":
return Optional.ofNullable(clazz.cast(dbInstanceClass()));
case "LicenseModel":
return Optional.ofNullable(clazz.cast(licenseModel()));
case "AvailabilityZoneGroup":
return Optional.ofNullable(clazz.cast(availabilityZoneGroup()));
case "Vpc":
return Optional.ofNullable(clazz.cast(vpc()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function