software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse 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 DescribeDBSnapshots action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeDbSnapshotsResponse extends RdsResponse implements
ToCopyableBuilder {
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeDbSnapshotsResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField> DB_SNAPSHOTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DBSnapshots")
.getter(getter(DescribeDbSnapshotsResponse::dbSnapshots))
.setter(setter(Builder::dbSnapshots))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSnapshots").build(),
ListTrait
.builder()
.memberLocationName("DBSnapshot")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DBSnapshot::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("DBSnapshot").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MARKER_FIELD,
DB_SNAPSHOTS_FIELD));
private final String marker;
private final List dbSnapshots;
private DescribeDbSnapshotsResponse(BuilderImpl builder) {
super(builder);
this.marker = builder.marker;
this.dbSnapshots = builder.dbSnapshots;
}
/**
*
* 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 DBSnapshots 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 hasDbSnapshots() {
return dbSnapshots != null && !(dbSnapshots instanceof SdkAutoConstructList);
}
/**
*
* A list of DBSnapshot 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 #hasDbSnapshots} method.
*
*
* @return A list of DBSnapshot instances.
*/
public final List dbSnapshots() {
return dbSnapshots;
}
@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(hasDbSnapshots() ? dbSnapshots() : 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 DescribeDbSnapshotsResponse)) {
return false;
}
DescribeDbSnapshotsResponse other = (DescribeDbSnapshotsResponse) obj;
return Objects.equals(marker(), other.marker()) && hasDbSnapshots() == other.hasDbSnapshots()
&& Objects.equals(dbSnapshots(), other.dbSnapshots());
}
/**
* 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("DescribeDbSnapshotsResponse").add("Marker", marker())
.add("DBSnapshots", hasDbSnapshots() ? dbSnapshots() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "DBSnapshots":
return Optional.ofNullable(clazz.cast(dbSnapshots()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDbSnapshotsResponse) 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 DBSnapshot instances.
*
*
* @param dbSnapshots
* A list of DBSnapshot instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSnapshots(Collection dbSnapshots);
/**
*
* A list of DBSnapshot instances.
*
*
* @param dbSnapshots
* A list of DBSnapshot instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSnapshots(DBSnapshot... dbSnapshots);
/**
*
* A list of DBSnapshot instances.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.DBSnapshot.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.rds.model.DBSnapshot#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.DBSnapshot.Builder#build()} is called immediately and its
* result is passed to {@link #dbSnapshots(List)}.
*
* @param dbSnapshots
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.DBSnapshot.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dbSnapshots(java.util.Collection)
*/
Builder dbSnapshots(Consumer... dbSnapshots);
}
static final class BuilderImpl extends RdsResponse.BuilderImpl implements Builder {
private String marker;
private List dbSnapshots = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeDbSnapshotsResponse model) {
super(model);
marker(model.marker);
dbSnapshots(model.dbSnapshots);
}
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 getDbSnapshots() {
List result = DBSnapshotListCopier.copyToBuilder(this.dbSnapshots);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDbSnapshots(Collection dbSnapshots) {
this.dbSnapshots = DBSnapshotListCopier.copyFromBuilder(dbSnapshots);
}
@Override
public final Builder dbSnapshots(Collection dbSnapshots) {
this.dbSnapshots = DBSnapshotListCopier.copy(dbSnapshots);
return this;
}
@Override
@SafeVarargs
public final Builder dbSnapshots(DBSnapshot... dbSnapshots) {
dbSnapshots(Arrays.asList(dbSnapshots));
return this;
}
@Override
@SafeVarargs
public final Builder dbSnapshots(Consumer... dbSnapshots) {
dbSnapshots(Stream.of(dbSnapshots).map(c -> DBSnapshot.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public DescribeDbSnapshotsResponse build() {
return new DescribeDbSnapshotsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}