software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse 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;
/**
*
* Response object for the DescribeBackups operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeBackupsResponse extends FSxResponse implements
ToCopyableBuilder {
private static final SdkField> BACKUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Backups")
.getter(getter(DescribeBackupsResponse::backups))
.setter(setter(Builder::backups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Backups").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Backup::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(DescribeBackupsResponse::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(BACKUPS_FIELD,
NEXT_TOKEN_FIELD));
private final List backups;
private final String nextToken;
private DescribeBackupsResponse(BuilderImpl builder) {
super(builder);
this.backups = builder.backups;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Backups 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 hasBackups() {
return backups != null && !(backups instanceof SdkAutoConstructList);
}
/**
*
* An array of backups.
*
*
* 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 #hasBackups} method.
*
*
* @return An array of backups.
*/
public final List backups() {
return backups;
}
/**
*
* A NextToken value is present if there are more backups than returned in the response. You can use
* the NextToken value in the subsequent request to fetch the backups.
*
*
* @return A NextToken value is present if there are more backups than returned in the response. You
* can use the NextToken value in the subsequent request to fetch the backups.
*/
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(hasBackups() ? backups() : 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 DescribeBackupsResponse)) {
return false;
}
DescribeBackupsResponse other = (DescribeBackupsResponse) obj;
return hasBackups() == other.hasBackups() && Objects.equals(backups(), other.backups())
&& 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("DescribeBackupsResponse").add("Backups", hasBackups() ? backups() : null)
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Backups":
return Optional.ofNullable(clazz.cast(backups()));
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((DescribeBackupsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FSxResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An array of backups.
*
*
* @param backups
* An array of backups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder backups(Collection backups);
/**
*
* An array of backups.
*
*
* @param backups
* An array of backups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder backups(Backup... backups);
/**
*
* An array of backups.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fsx.model.Backup.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.fsx.model.Backup#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.fsx.model.Backup.Builder#build()}
* is called immediately and its result is passed to {@link #backups(List)}.
*
* @param backups
* a consumer that will call methods on {@link software.amazon.awssdk.services.fsx.model.Backup.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #backups(java.util.Collection)
*/
Builder backups(Consumer... backups);
/**
*
* A NextToken value is present if there are more backups than returned in the response. You can
* use the NextToken value in the subsequent request to fetch the backups.
*
*
* @param nextToken
* A NextToken value is present if there are more backups than returned in the response. You
* can use the NextToken value in the subsequent request to fetch the backups.
* @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 backups = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeBackupsResponse model) {
super(model);
backups(model.backups);
nextToken(model.nextToken);
}
public final List getBackups() {
List result = BackupsCopier.copyToBuilder(this.backups);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setBackups(Collection backups) {
this.backups = BackupsCopier.copyFromBuilder(backups);
}
@Override
public final Builder backups(Collection backups) {
this.backups = BackupsCopier.copy(backups);
return this;
}
@Override
@SafeVarargs
public final Builder backups(Backup... backups) {
backups(Arrays.asList(backups));
return this;
}
@Override
@SafeVarargs
public final Builder backups(Consumer... backups) {
backups(Stream.of(backups).map(c -> Backup.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 DescribeBackupsResponse build() {
return new DescribeBackupsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}