software.amazon.awssdk.services.storagegateway.model.DescribeTapesResponse Maven / Gradle / Ivy
/*
* 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.storagegateway.model;
import java.beans.Transient;
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;
/**
*
* DescribeTapesOutput
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeTapesResponse extends StorageGatewayResponse implements
ToCopyableBuilder {
private static final SdkField> TAPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tapes")
.getter(getter(DescribeTapesResponse::tapes))
.setter(setter(Builder::tapes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tapes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tape::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeTapesResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TAPES_FIELD, MARKER_FIELD));
private final List tapes;
private final String marker;
private DescribeTapesResponse(BuilderImpl builder) {
super(builder);
this.tapes = builder.tapes;
this.marker = builder.marker;
}
/**
* For responses, this returns true if the service returned a value for the Tapes 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 hasTapes() {
return tapes != null && !(tapes instanceof SdkAutoConstructList);
}
/**
*
* An array of virtual tape descriptions.
*
*
* 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 #hasTapes} method.
*
*
* @return An array of virtual tape descriptions.
*/
public final List tapes() {
return tapes;
}
/**
*
* An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next
* page of results.
*
*
* If a response does not contain a marker, then there are no more results to be retrieved.
*
*
* @return An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the
* next page of results.
*
* If a response does not contain a marker, then there are no more results to be retrieved.
*/
public final String marker() {
return marker;
}
@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(hasTapes() ? tapes() : null);
hashCode = 31 * hashCode + Objects.hashCode(marker());
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 DescribeTapesResponse)) {
return false;
}
DescribeTapesResponse other = (DescribeTapesResponse) obj;
return hasTapes() == other.hasTapes() && Objects.equals(tapes(), other.tapes())
&& Objects.equals(marker(), other.marker());
}
/**
* 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("DescribeTapesResponse").add("Tapes", hasTapes() ? tapes() : null).add("Marker", marker())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Tapes":
return Optional.ofNullable(clazz.cast(tapes()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeTapesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends StorageGatewayResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An array of virtual tape descriptions.
*
*
* @param tapes
* An array of virtual tape descriptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tapes(Collection tapes);
/**
*
* An array of virtual tape descriptions.
*
*
* @param tapes
* An array of virtual tape descriptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tapes(Tape... tapes);
/**
*
* An array of virtual tape descriptions.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tapes(List)}.
*
* @param tapes
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tapes(List)
*/
Builder tapes(Consumer... tapes);
/**
*
* An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the
* next page of results.
*
*
* If a response does not contain a marker, then there are no more results to be retrieved.
*
*
* @param marker
* An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve
* the next page of results.
*
* If a response does not contain a marker, then there are no more results to be retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
}
static final class BuilderImpl extends StorageGatewayResponse.BuilderImpl implements Builder {
private List tapes = DefaultSdkAutoConstructList.getInstance();
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeTapesResponse model) {
super(model);
tapes(model.tapes);
marker(model.marker);
}
public final List getTapes() {
List result = TapesCopier.copyToBuilder(this.tapes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTapes(Collection tapes) {
this.tapes = TapesCopier.copyFromBuilder(tapes);
}
@Override
@Transient
public final Builder tapes(Collection tapes) {
this.tapes = TapesCopier.copy(tapes);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tapes(Tape... tapes) {
tapes(Arrays.asList(tapes));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tapes(Consumer... tapes) {
tapes(Stream.of(tapes).map(c -> Tape.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
@Transient
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
@Override
public DescribeTapesResponse build() {
return new DescribeTapesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}