software.amazon.awssdk.services.rds.model.DBSnapshotAttributesResult 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.io.Serializable;
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 results of a successful call to the DescribeDBSnapshotAttributes API action.
*
*
* Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB
* snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DBSnapshotAttributesResult implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DB_SNAPSHOT_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSnapshotIdentifier").getter(getter(DBSnapshotAttributesResult::dbSnapshotIdentifier))
.setter(setter(Builder::dbSnapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSnapshotIdentifier").build())
.build();
private static final SdkField> DB_SNAPSHOT_ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DBSnapshotAttributes")
.getter(getter(DBSnapshotAttributesResult::dbSnapshotAttributes))
.setter(setter(Builder::dbSnapshotAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSnapshotAttributes").build(),
ListTrait
.builder()
.memberLocationName("DBSnapshotAttribute")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DBSnapshotAttribute::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("DBSnapshotAttribute").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_SNAPSHOT_IDENTIFIER_FIELD,
DB_SNAPSHOT_ATTRIBUTES_FIELD));
private static final long serialVersionUID = 1L;
private final String dbSnapshotIdentifier;
private final List dbSnapshotAttributes;
private DBSnapshotAttributesResult(BuilderImpl builder) {
this.dbSnapshotIdentifier = builder.dbSnapshotIdentifier;
this.dbSnapshotAttributes = builder.dbSnapshotAttributes;
}
/**
*
* The identifier of the manual DB snapshot that the attributes apply to.
*
*
* @return The identifier of the manual DB snapshot that the attributes apply to.
*/
public final String dbSnapshotIdentifier() {
return dbSnapshotIdentifier;
}
/**
* For responses, this returns true if the service returned a value for the DBSnapshotAttributes 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 hasDbSnapshotAttributes() {
return dbSnapshotAttributes != null && !(dbSnapshotAttributes instanceof SdkAutoConstructList);
}
/**
*
* The list of attributes and values for the manual DB snapshot.
*
*
* 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 #hasDbSnapshotAttributes} method.
*
*
* @return The list of attributes and values for the manual DB snapshot.
*/
public final List dbSnapshotAttributes() {
return dbSnapshotAttributes;
}
@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 + Objects.hashCode(dbSnapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(hasDbSnapshotAttributes() ? dbSnapshotAttributes() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DBSnapshotAttributesResult)) {
return false;
}
DBSnapshotAttributesResult other = (DBSnapshotAttributesResult) obj;
return Objects.equals(dbSnapshotIdentifier(), other.dbSnapshotIdentifier())
&& hasDbSnapshotAttributes() == other.hasDbSnapshotAttributes()
&& Objects.equals(dbSnapshotAttributes(), other.dbSnapshotAttributes());
}
/**
* 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("DBSnapshotAttributesResult").add("DBSnapshotIdentifier", dbSnapshotIdentifier())
.add("DBSnapshotAttributes", hasDbSnapshotAttributes() ? dbSnapshotAttributes() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBSnapshotIdentifier":
return Optional.ofNullable(clazz.cast(dbSnapshotIdentifier()));
case "DBSnapshotAttributes":
return Optional.ofNullable(clazz.cast(dbSnapshotAttributes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DBSnapshotAttributesResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier of the manual DB snapshot that the attributes apply to.
*
*
* @param dbSnapshotIdentifier
* The identifier of the manual DB snapshot that the attributes apply to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSnapshotIdentifier(String dbSnapshotIdentifier);
/**
*
* The list of attributes and values for the manual DB snapshot.
*
*
* @param dbSnapshotAttributes
* The list of attributes and values for the manual DB snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSnapshotAttributes(Collection dbSnapshotAttributes);
/**
*
* The list of attributes and values for the manual DB snapshot.
*
*
* @param dbSnapshotAttributes
* The list of attributes and values for the manual DB snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSnapshotAttributes(DBSnapshotAttribute... dbSnapshotAttributes);
/**
*
* The list of attributes and values for the manual DB snapshot.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.DBSnapshotAttribute.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.rds.model.DBSnapshotAttribute#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.DBSnapshotAttribute.Builder#build()} is called immediately
* and its result is passed to {@link #dbSnapshotAttributes(List)}.
*
* @param dbSnapshotAttributes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.DBSnapshotAttribute.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dbSnapshotAttributes(java.util.Collection)
*/
Builder dbSnapshotAttributes(Consumer... dbSnapshotAttributes);
}
static final class BuilderImpl implements Builder {
private String dbSnapshotIdentifier;
private List dbSnapshotAttributes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DBSnapshotAttributesResult model) {
dbSnapshotIdentifier(model.dbSnapshotIdentifier);
dbSnapshotAttributes(model.dbSnapshotAttributes);
}
public final String getDbSnapshotIdentifier() {
return dbSnapshotIdentifier;
}
public final void setDbSnapshotIdentifier(String dbSnapshotIdentifier) {
this.dbSnapshotIdentifier = dbSnapshotIdentifier;
}
@Override
public final Builder dbSnapshotIdentifier(String dbSnapshotIdentifier) {
this.dbSnapshotIdentifier = dbSnapshotIdentifier;
return this;
}
public final List getDbSnapshotAttributes() {
List result = DBSnapshotAttributeListCopier.copyToBuilder(this.dbSnapshotAttributes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDbSnapshotAttributes(Collection dbSnapshotAttributes) {
this.dbSnapshotAttributes = DBSnapshotAttributeListCopier.copyFromBuilder(dbSnapshotAttributes);
}
@Override
public final Builder dbSnapshotAttributes(Collection dbSnapshotAttributes) {
this.dbSnapshotAttributes = DBSnapshotAttributeListCopier.copy(dbSnapshotAttributes);
return this;
}
@Override
@SafeVarargs
public final Builder dbSnapshotAttributes(DBSnapshotAttribute... dbSnapshotAttributes) {
dbSnapshotAttributes(Arrays.asList(dbSnapshotAttributes));
return this;
}
@Override
@SafeVarargs
public final Builder dbSnapshotAttributes(Consumer... dbSnapshotAttributes) {
dbSnapshotAttributes(Stream.of(dbSnapshotAttributes).map(c -> DBSnapshotAttribute.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public DBSnapshotAttributesResult build() {
return new DBSnapshotAttributesResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}