software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest 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 DescribeOptionGroupsRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField OPTION_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OptionGroupName").getter(getter(DescribeOptionGroupsRequest::optionGroupName))
.setter(setter(Builder::optionGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OptionGroupName").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeOptionGroupsRequest::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 MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeOptionGroupsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeOptionGroupsRequest::maxRecords)).setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField ENGINE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineName").getter(getter(DescribeOptionGroupsRequest::engineName)).setter(setter(Builder::engineName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EngineName").build()).build();
private static final SdkField MAJOR_ENGINE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MajorEngineVersion").getter(getter(DescribeOptionGroupsRequest::majorEngineVersion))
.setter(setter(Builder::majorEngineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MajorEngineVersion").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OPTION_GROUP_NAME_FIELD,
FILTERS_FIELD, MARKER_FIELD, MAX_RECORDS_FIELD, ENGINE_NAME_FIELD, MAJOR_ENGINE_VERSION_FIELD));
private final String optionGroupName;
private final List filters;
private final String marker;
private final Integer maxRecords;
private final String engineName;
private final String majorEngineVersion;
private DescribeOptionGroupsRequest(BuilderImpl builder) {
super(builder);
this.optionGroupName = builder.optionGroupName;
this.filters = builder.filters;
this.marker = builder.marker;
this.maxRecords = builder.maxRecords;
this.engineName = builder.engineName;
this.majorEngineVersion = builder.majorEngineVersion;
}
/**
*
* The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
*
*
* @return The name of the option group to describe. Can't be supplied together with EngineName or
* MajorEngineVersion.
*/
public final String optionGroupName() {
return optionGroupName;
}
/**
* 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;
}
/**
*
* An optional pagination token provided by a previous DescribeOptionGroups 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 DescribeOptionGroups 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;
}
/**
*
* 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 100.
*
*
* @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 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* A filter to only include option groups associated with this database engine.
*
*
* Valid Values:
*
*
* -
*
* 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 A filter to only include option groups associated with this database engine.
*
* Valid Values:
*
*
* -
*
* 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 engineName() {
return engineName;
}
/**
*
* Filters the list of option groups to only include groups associated with a specific database engine version. If
* specified, then EngineName must also be specified.
*
*
* @return Filters the list of option groups to only include groups associated with a specific database engine
* version. If specified, then EngineName must also be specified.
*/
public final String majorEngineVersion() {
return majorEngineVersion;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(optionGroupName());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(engineName());
hashCode = 31 * hashCode + Objects.hashCode(majorEngineVersion());
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 DescribeOptionGroupsRequest)) {
return false;
}
DescribeOptionGroupsRequest other = (DescribeOptionGroupsRequest) obj;
return Objects.equals(optionGroupName(), other.optionGroupName()) && hasFilters() == other.hasFilters()
&& Objects.equals(filters(), other.filters()) && Objects.equals(marker(), other.marker())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(engineName(), other.engineName())
&& Objects.equals(majorEngineVersion(), other.majorEngineVersion());
}
/**
* 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("DescribeOptionGroupsRequest").add("OptionGroupName", optionGroupName())
.add("Filters", hasFilters() ? filters() : null).add("Marker", marker()).add("MaxRecords", maxRecords())
.add("EngineName", engineName()).add("MajorEngineVersion", majorEngineVersion()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OptionGroupName":
return Optional.ofNullable(clazz.cast(optionGroupName()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "EngineName":
return Optional.ofNullable(clazz.cast(engineName()));
case "MajorEngineVersion":
return Optional.ofNullable(clazz.cast(majorEngineVersion()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeOptionGroupsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
*
*
* @param optionGroupName
* The name of the option group to describe. Can't be supplied together with EngineName or
* MajorEngineVersion.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder optionGroupName(String optionGroupName);
/**
*
* This parameter isn't currently supported.
*
*
* @param filters
* This parameter isn't currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* This parameter isn't currently supported.
*
*
* @param filters
* This parameter isn't currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* This parameter isn't currently supported.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.Filter.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.rds.model.Filter#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.rds.model.Filter.Builder#build()}
* is called immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link software.amazon.awssdk.services.rds.model.Filter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
/**
*
* An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is
* specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is
* specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* 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 100.
*
*
* @param 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 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
/**
*
* A filter to only include option groups associated with this database engine.
*
*
* Valid Values:
*
*
* -
*
* 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
*
*
*
*
* @param engineName
* A filter to only include option groups associated with this database engine.
*
* Valid Values:
*
*
* -
*
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder engineName(String engineName);
/**
*
* Filters the list of option groups to only include groups associated with a specific database engine version.
* If specified, then EngineName must also be specified.
*
*
* @param majorEngineVersion
* Filters the list of option groups to only include groups associated with a specific database engine
* version. If specified, then EngineName must also be specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder majorEngineVersion(String majorEngineVersion);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String optionGroupName;
private List filters = DefaultSdkAutoConstructList.getInstance();
private String marker;
private Integer maxRecords;
private String engineName;
private String majorEngineVersion;
private BuilderImpl() {
}
private BuilderImpl(DescribeOptionGroupsRequest model) {
super(model);
optionGroupName(model.optionGroupName);
filters(model.filters);
marker(model.marker);
maxRecords(model.maxRecords);
engineName(model.engineName);
majorEngineVersion(model.majorEngineVersion);
}
public final String getOptionGroupName() {
return optionGroupName;
}
public final void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
@Override
public final Builder optionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
return this;
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final Integer getMaxRecords() {
return maxRecords;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
public final String getEngineName() {
return engineName;
}
public final void setEngineName(String engineName) {
this.engineName = engineName;
}
@Override
public final Builder engineName(String engineName) {
this.engineName = engineName;
return this;
}
public final String getMajorEngineVersion() {
return majorEngineVersion;
}
public final void setMajorEngineVersion(String majorEngineVersion) {
this.majorEngineVersion = majorEngineVersion;
}
@Override
public final Builder majorEngineVersion(String majorEngineVersion) {
this.majorEngineVersion = majorEngineVersion;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeOptionGroupsRequest build() {
return new DescribeOptionGroupsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}