software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse Maven / Gradle / Ivy
Show all versions of fsx 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.fsx.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeVolumesResponse extends FSxResponse implements
ToCopyableBuilder {
private static final SdkField> VOLUMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Volumes")
.getter(getter(DescribeVolumesResponse::volumes))
.setter(setter(Builder::volumes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Volumes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Volume::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeVolumesResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VOLUMES_FIELD,
NEXT_TOKEN_FIELD));
private final List volumes;
private final String nextToken;
private DescribeVolumesResponse(BuilderImpl builder) {
super(builder);
this.volumes = builder.volumes;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Volumes 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 hasVolumes() {
return volumes != null && !(volumes instanceof SdkAutoConstructList);
}
/**
*
* Returned after a successful DescribeVolumes operation, describing each volume.
*
*
* 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 #hasVolumes} method.
*
*
* @return Returned after a successful DescribeVolumes operation, describing each volume.
*/
public final List volumes() {
return volumes;
}
/**
* Returns the value of the NextToken property for this object.
*
* @return The value of the NextToken property for this object.
*/
public final String nextToken() {
return nextToken;
}
@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(hasVolumes() ? volumes() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
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 DescribeVolumesResponse)) {
return false;
}
DescribeVolumesResponse other = (DescribeVolumesResponse) obj;
return hasVolumes() == other.hasVolumes() && Objects.equals(volumes(), other.volumes())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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("DescribeVolumesResponse").add("Volumes", hasVolumes() ? volumes() : null)
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Volumes":
return Optional.ofNullable(clazz.cast(volumes()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeVolumesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FSxResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Returned after a successful DescribeVolumes operation, describing each volume.
*
*
* @param volumes
* Returned after a successful DescribeVolumes operation, describing each volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder volumes(Collection volumes);
/**
*
* Returned after a successful DescribeVolumes operation, describing each volume.
*
*
* @param volumes
* Returned after a successful DescribeVolumes operation, describing each volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder volumes(Volume... volumes);
/**
*
* Returned after a successful DescribeVolumes operation, describing each volume.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fsx.model.Volume.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.fsx.model.Volume#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.fsx.model.Volume.Builder#build()}
* is called immediately and its result is passed to {@link #volumes(List)}.
*
* @param volumes
* a consumer that will call methods on {@link software.amazon.awssdk.services.fsx.model.Volume.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #volumes(java.util.Collection)
*/
Builder volumes(Consumer... volumes);
/**
* Sets the value of the NextToken property for this object.
*
* @param nextToken
* The new value for the NextToken property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends FSxResponse.BuilderImpl implements Builder {
private List volumes = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeVolumesResponse model) {
super(model);
volumes(model.volumes);
nextToken(model.nextToken);
}
public final List getVolumes() {
List result = VolumesCopier.copyToBuilder(this.volumes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setVolumes(Collection volumes) {
this.volumes = VolumesCopier.copyFromBuilder(volumes);
}
@Override
public final Builder volumes(Collection volumes) {
this.volumes = VolumesCopier.copy(volumes);
return this;
}
@Override
@SafeVarargs
public final Builder volumes(Volume... volumes) {
volumes(Arrays.asList(volumes));
return this;
}
@Override
@SafeVarargs
public final Builder volumes(Consumer... volumes) {
volumes(Stream.of(volumes).map(c -> Volume.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public DescribeVolumesResponse build() {
return new DescribeVolumesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}