software.amazon.awssdk.services.neptune.model.DBClusterSnapshotAttribute Maven / Gradle / Ivy
Show all versions of neptune 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.neptune.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.Function;
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 name and values of a manual DB cluster snapshot attribute.
*
*
* Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster
* snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DBClusterSnapshotAttribute implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ATTRIBUTE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AttributeName").getter(getter(DBClusterSnapshotAttribute::attributeName))
.setter(setter(Builder::attributeName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttributeName").build()).build();
private static final SdkField> ATTRIBUTE_VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AttributeValues")
.getter(getter(DBClusterSnapshotAttribute::attributeValues))
.setter(setter(Builder::attributeValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttributeValues").build(),
ListTrait
.builder()
.memberLocationName("AttributeValue")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("AttributeValue").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTE_NAME_FIELD,
ATTRIBUTE_VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final String attributeName;
private final List attributeValues;
private DBClusterSnapshotAttribute(BuilderImpl builder) {
this.attributeName = builder.attributeName;
this.attributeValues = builder.attributeValues;
}
/**
*
* The name of the manual DB cluster snapshot attribute.
*
*
* The attribute named restore refers to the list of Amazon accounts that have permission to copy or
* restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API
* action.
*
*
* @return The name of the manual DB cluster snapshot attribute.
*
* The attribute named restore refers to the list of Amazon accounts that have permission to
* copy or restore the manual DB cluster snapshot. For more information, see the
* ModifyDBClusterSnapshotAttribute API action.
*/
public final String attributeName() {
return attributeName;
}
/**
* For responses, this returns true if the service returned a value for the AttributeValues 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 hasAttributeValues() {
return attributeValues != null && !(attributeValues instanceof SdkAutoConstructList);
}
/**
*
* The value(s) for the manual DB cluster snapshot attribute.
*
*
* If the AttributeName field is set to restore, then this element returns a list of IDs
* of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of
* all is in the list, then the manual DB cluster snapshot is public and available for any Amazon
* account to copy or restore.
*
*
* 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 #hasAttributeValues} method.
*
*
* @return The value(s) for the manual DB cluster snapshot attribute.
*
* If the AttributeName field is set to restore, then this element returns a list
* of IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a
* value of all is in the list, then the manual DB cluster snapshot is public and available for
* any Amazon account to copy or restore.
*/
public final List attributeValues() {
return attributeValues;
}
@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(attributeName());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributeValues() ? attributeValues() : 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 DBClusterSnapshotAttribute)) {
return false;
}
DBClusterSnapshotAttribute other = (DBClusterSnapshotAttribute) obj;
return Objects.equals(attributeName(), other.attributeName()) && hasAttributeValues() == other.hasAttributeValues()
&& Objects.equals(attributeValues(), other.attributeValues());
}
/**
* 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("DBClusterSnapshotAttribute").add("AttributeName", attributeName())
.add("AttributeValues", hasAttributeValues() ? attributeValues() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AttributeName":
return Optional.ofNullable(clazz.cast(attributeName()));
case "AttributeValues":
return Optional.ofNullable(clazz.cast(attributeValues()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DBClusterSnapshotAttribute) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the manual DB cluster snapshot attribute.
*
*
* The attribute named restore refers to the list of Amazon accounts that have permission to copy
* or restore the manual DB cluster snapshot. For more information, see the
* ModifyDBClusterSnapshotAttribute API action.
*
*
* @param attributeName
* The name of the manual DB cluster snapshot attribute.
*
* The attribute named restore refers to the list of Amazon accounts that have permission to
* copy or restore the manual DB cluster snapshot. For more information, see the
* ModifyDBClusterSnapshotAttribute API action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeName(String attributeName);
/**
*
* The value(s) for the manual DB cluster snapshot attribute.
*
*
* If the AttributeName field is set to restore, then this element returns a list of
* IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value
* of all is in the list, then the manual DB cluster snapshot is public and available for any
* Amazon account to copy or restore.
*
*
* @param attributeValues
* The value(s) for the manual DB cluster snapshot attribute.
*
* If the AttributeName field is set to restore, then this element returns a
* list of IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster
* snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public
* and available for any Amazon account to copy or restore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeValues(Collection attributeValues);
/**
*
* The value(s) for the manual DB cluster snapshot attribute.
*
*
* If the AttributeName field is set to restore, then this element returns a list of
* IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value
* of all is in the list, then the manual DB cluster snapshot is public and available for any
* Amazon account to copy or restore.
*
*
* @param attributeValues
* The value(s) for the manual DB cluster snapshot attribute.
*
* If the AttributeName field is set to restore, then this element returns a
* list of IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster
* snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public
* and available for any Amazon account to copy or restore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeValues(String... attributeValues);
}
static final class BuilderImpl implements Builder {
private String attributeName;
private List attributeValues = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DBClusterSnapshotAttribute model) {
attributeName(model.attributeName);
attributeValues(model.attributeValues);
}
public final String getAttributeName() {
return attributeName;
}
public final void setAttributeName(String attributeName) {
this.attributeName = attributeName;
}
@Override
public final Builder attributeName(String attributeName) {
this.attributeName = attributeName;
return this;
}
public final Collection getAttributeValues() {
if (attributeValues instanceof SdkAutoConstructList) {
return null;
}
return attributeValues;
}
public final void setAttributeValues(Collection attributeValues) {
this.attributeValues = AttributeValueListCopier.copy(attributeValues);
}
@Override
public final Builder attributeValues(Collection attributeValues) {
this.attributeValues = AttributeValueListCopier.copy(attributeValues);
return this;
}
@Override
@SafeVarargs
public final Builder attributeValues(String... attributeValues) {
attributeValues(Arrays.asList(attributeValues));
return this;
}
@Override
public DBClusterSnapshotAttribute build() {
return new DBClusterSnapshotAttribute(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}