software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse Maven / Gradle / Ivy
Show all versions of elasticache 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.elasticache.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;
/**
*
* Represents the output of a DescribeSnapshots operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeSnapshotsResponse extends ElastiCacheResponse implements
ToCopyableBuilder {
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeSnapshotsResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField> SNAPSHOTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Snapshots")
.getter(getter(DescribeSnapshotsResponse::snapshots))
.setter(setter(Builder::snapshots))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Snapshots").build(),
ListTrait
.builder()
.memberLocationName("Snapshot")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Snapshot::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Snapshot").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(MARKER_FIELD, SNAPSHOTS_FIELD));
private final String marker;
private final List snapshots;
private DescribeSnapshotsResponse(BuilderImpl builder) {
super(builder);
this.marker = builder.marker;
this.snapshots = builder.snapshots;
}
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords.
*
*
* @return An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. 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 Snapshots 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 hasSnapshots() {
return snapshots != null && !(snapshots instanceof SdkAutoConstructList);
}
/**
*
* A list of snapshots. Each item in the list contains detailed information about one 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 #hasSnapshots} method.
*
*
* @return A list of snapshots. Each item in the list contains detailed information about one snapshot.
*/
public final List snapshots() {
return snapshots;
}
@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(hasSnapshots() ? snapshots() : 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 DescribeSnapshotsResponse)) {
return false;
}
DescribeSnapshotsResponse other = (DescribeSnapshotsResponse) obj;
return Objects.equals(marker(), other.marker()) && hasSnapshots() == other.hasSnapshots()
&& Objects.equals(snapshots(), other.snapshots());
}
/**
* 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("DescribeSnapshotsResponse").add("Marker", marker())
.add("Snapshots", hasSnapshots() ? snapshots() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "Snapshots":
return Optional.ofNullable(clazz.cast(snapshots()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeSnapshotsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElastiCacheResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to the
* value specified by MaxRecords.
*
*
* @param marker
* An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. 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 snapshots. Each item in the list contains detailed information about one snapshot.
*
*
* @param snapshots
* A list of snapshots. Each item in the list contains detailed information about one snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshots(Collection snapshots);
/**
*
* A list of snapshots. Each item in the list contains detailed information about one snapshot.
*
*
* @param snapshots
* A list of snapshots. Each item in the list contains detailed information about one snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshots(Snapshot... snapshots);
/**
*
* A list of snapshots. Each item in the list contains detailed information about one snapshot.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.elasticache.model.Snapshot.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.elasticache.model.Snapshot#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.elasticache.model.Snapshot.Builder#build()} is called immediately and
* its result is passed to {@link #snapshots(List)}.
*
* @param snapshots
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.elasticache.model.Snapshot.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #snapshots(java.util.Collection)
*/
Builder snapshots(Consumer... snapshots);
}
static final class BuilderImpl extends ElastiCacheResponse.BuilderImpl implements Builder {
private String marker;
private List snapshots = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeSnapshotsResponse model) {
super(model);
marker(model.marker);
snapshots(model.snapshots);
}
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 getSnapshots() {
List result = SnapshotListCopier.copyToBuilder(this.snapshots);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSnapshots(Collection snapshots) {
this.snapshots = SnapshotListCopier.copyFromBuilder(snapshots);
}
@Override
public final Builder snapshots(Collection snapshots) {
this.snapshots = SnapshotListCopier.copy(snapshots);
return this;
}
@Override
@SafeVarargs
public final Builder snapshots(Snapshot... snapshots) {
snapshots(Arrays.asList(snapshots));
return this;
}
@Override
@SafeVarargs
public final Builder snapshots(Consumer... snapshots) {
snapshots(Stream.of(snapshots).map(c -> Snapshot.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public DescribeSnapshotsResponse build() {
return new DescribeSnapshotsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}