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