software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse 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.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;
/**
*
* Contains the result of a successful invocation of the DescribeDBInstances action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeDbInstancesResponse extends RdsResponse implements
ToCopyableBuilder {
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeDbInstancesResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField> DB_INSTANCES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DBInstances")
.getter(getter(DescribeDbInstancesResponse::dbInstances))
.setter(setter(Builder::dbInstances))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstances").build(),
ListTrait
.builder()
.memberLocationName("DBInstance")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DBInstance::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("DBInstance").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MARKER_FIELD,
DB_INSTANCES_FIELD));
private final String marker;
private final List dbInstances;
private DescribeDbInstancesResponse(BuilderImpl builder) {
super(builder);
this.marker = builder.marker;
this.dbInstances = builder.dbInstances;
}
/**
*
* An optional pagination token provided by a previous 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 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;
}
/**
* For responses, this returns true if the service returned a value for the DBInstances 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 hasDbInstances() {
return dbInstances != null && !(dbInstances instanceof SdkAutoConstructList);
}
/**
*
* A list of DBInstance instances.
*
*
* 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 #hasDbInstances} method.
*
*
* @return A list of DBInstance instances.
*/
public final List dbInstances() {
return dbInstances;
}
@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(marker());
hashCode = 31 * hashCode + Objects.hashCode(hasDbInstances() ? dbInstances() : null);
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 DescribeDbInstancesResponse)) {
return false;
}
DescribeDbInstancesResponse other = (DescribeDbInstancesResponse) obj;
return Objects.equals(marker(), other.marker()) && hasDbInstances() == other.hasDbInstances()
&& Objects.equals(dbInstances(), other.dbInstances());
}
/**
* 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("DescribeDbInstancesResponse").add("Marker", marker())
.add("DBInstances", hasDbInstances() ? dbInstances() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "DBInstances":
return Optional.ofNullable(clazz.cast(dbInstances()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDbInstancesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An optional pagination token provided by a previous 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 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);
/**
*
* A list of DBInstance instances.
*
*
* @param dbInstances
* A list of DBInstance instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstances(Collection dbInstances);
/**
*
* A list of DBInstance instances.
*
*
* @param dbInstances
* A list of DBInstance instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstances(DBInstance... dbInstances);
/**
*
* A list of DBInstance instances.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.DBInstance.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.rds.model.DBInstance#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.DBInstance.Builder#build()} is called immediately and its
* result is passed to {@link #dbInstances(List)}.
*
* @param dbInstances
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.DBInstance.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dbInstances(java.util.Collection)
*/
Builder dbInstances(Consumer... dbInstances);
}
static final class BuilderImpl extends RdsResponse.BuilderImpl implements Builder {
private String marker;
private List dbInstances = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeDbInstancesResponse model) {
super(model);
marker(model.marker);
dbInstances(model.dbInstances);
}
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 List getDbInstances() {
List result = DBInstanceListCopier.copyToBuilder(this.dbInstances);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDbInstances(Collection dbInstances) {
this.dbInstances = DBInstanceListCopier.copyFromBuilder(dbInstances);
}
@Override
public final Builder dbInstances(Collection dbInstances) {
this.dbInstances = DBInstanceListCopier.copy(dbInstances);
return this;
}
@Override
@SafeVarargs
public final Builder dbInstances(DBInstance... dbInstances) {
dbInstances(Arrays.asList(dbInstances));
return this;
}
@Override
@SafeVarargs
public final Builder dbInstances(Consumer... dbInstances) {
dbInstances(Stream.of(dbInstances).map(c -> DBInstance.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public DescribeDbInstancesResponse build() {
return new DescribeDbInstancesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}