software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest 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.awscore.AwsRequestOverrideConfiguration;
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 DescribeSnapshotsRequest extends FSxRequest implements
ToCopyableBuilder {
private static final SdkField> SNAPSHOT_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SnapshotIds")
.getter(getter(DescribeSnapshotsRequest::snapshotIds))
.setter(setter(Builder::snapshotIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeSnapshotsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SnapshotFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(DescribeSnapshotsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeSnapshotsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField INCLUDE_SHARED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludeShared").getter(getter(DescribeSnapshotsRequest::includeShared))
.setter(setter(Builder::includeShared))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludeShared").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SNAPSHOT_IDS_FIELD,
FILTERS_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, INCLUDE_SHARED_FIELD));
private final List snapshotIds;
private final List filters;
private final Integer maxResults;
private final String nextToken;
private final Boolean includeShared;
private DescribeSnapshotsRequest(BuilderImpl builder) {
super(builder);
this.snapshotIds = builder.snapshotIds;
this.filters = builder.filters;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.includeShared = builder.includeShared;
}
/**
* For responses, this returns true if the service returned a value for the SnapshotIds 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 hasSnapshotIds() {
return snapshotIds != null && !(snapshotIds instanceof SdkAutoConstructList);
}
/**
*
* The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't
* found, a SnapshotNotFound error occurs.
*
*
* 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 #hasSnapshotIds} method.
*
*
* @return The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any
* IDs aren't found, a SnapshotNotFound error occurs.
*/
public final List snapshotIds() {
return snapshotIds;
}
/**
* For responses, this returns true if the service returned a value for the Filters 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 hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* The filters structure. The supported names are file-system-id or volume-id.
*
*
* 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 #hasFilters} method.
*
*
* @return The filters structure. The supported names are file-system-id or volume-id.
*/
public final List filters() {
return filters;
}
/**
* Returns the value of the MaxResults property for this object.
*
* @return The value of the MaxResults property for this object.
*/
public final Integer maxResults() {
return maxResults;
}
/**
* 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;
}
/**
*
* Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services
* account. Set to true if you want to see the snapshots in your account and the ones shared with you
* from another account.
*
*
* @return Set to false (default) if you want to only see the snapshots owned by your Amazon Web
* Services account. Set to true if you want to see the snapshots in your account and the ones
* shared with you from another account.
*/
public final Boolean includeShared() {
return includeShared;
}
@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(hasSnapshotIds() ? snapshotIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(includeShared());
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 DescribeSnapshotsRequest)) {
return false;
}
DescribeSnapshotsRequest other = (DescribeSnapshotsRequest) obj;
return hasSnapshotIds() == other.hasSnapshotIds() && Objects.equals(snapshotIds(), other.snapshotIds())
&& hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(includeShared(), other.includeShared());
}
/**
* 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("DescribeSnapshotsRequest").add("SnapshotIds", hasSnapshotIds() ? snapshotIds() : null)
.add("Filters", hasFilters() ? filters() : null).add("MaxResults", maxResults()).add("NextToken", nextToken())
.add("IncludeShared", includeShared()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SnapshotIds":
return Optional.ofNullable(clazz.cast(snapshotIds()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "IncludeShared":
return Optional.ofNullable(clazz.cast(includeShared()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeSnapshotsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs
* aren't found, a SnapshotNotFound error occurs.
*
*
* @param snapshotIds
* The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any
* IDs aren't found, a SnapshotNotFound error occurs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotIds(Collection snapshotIds);
/**
*
* The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs
* aren't found, a SnapshotNotFound error occurs.
*
*
* @param snapshotIds
* The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any
* IDs aren't found, a SnapshotNotFound error occurs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotIds(String... snapshotIds);
/**
*
* The filters structure. The supported names are file-system-id or volume-id.
*
*
* @param filters
* The filters structure. The supported names are file-system-id or volume-id.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* The filters structure. The supported names are file-system-id or volume-id.
*
*
* @param filters
* The filters structure. The supported names are file-system-id or volume-id.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(SnapshotFilter... filters);
/**
*
* The filters structure. The supported names are file-system-id or volume-id.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fsx.model.SnapshotFilter.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.fsx.model.SnapshotFilter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.fsx.model.SnapshotFilter.Builder#build()} is called immediately and
* its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.fsx.model.SnapshotFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
/**
* Sets the value of the MaxResults property for this object.
*
* @param maxResults
* The new value for the MaxResults property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
* 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);
/**
*
* Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services
* account. Set to true if you want to see the snapshots in your account and the ones shared with
* you from another account.
*
*
* @param includeShared
* Set to false (default) if you want to only see the snapshots owned by your Amazon Web
* Services account. Set to true if you want to see the snapshots in your account and the
* ones shared with you from another account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeShared(Boolean includeShared);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends FSxRequest.BuilderImpl implements Builder {
private List snapshotIds = DefaultSdkAutoConstructList.getInstance();
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer maxResults;
private String nextToken;
private Boolean includeShared;
private BuilderImpl() {
}
private BuilderImpl(DescribeSnapshotsRequest model) {
super(model);
snapshotIds(model.snapshotIds);
filters(model.filters);
maxResults(model.maxResults);
nextToken(model.nextToken);
includeShared(model.includeShared);
}
public final Collection getSnapshotIds() {
if (snapshotIds instanceof SdkAutoConstructList) {
return null;
}
return snapshotIds;
}
public final void setSnapshotIds(Collection snapshotIds) {
this.snapshotIds = SnapshotIdsCopier.copy(snapshotIds);
}
@Override
public final Builder snapshotIds(Collection snapshotIds) {
this.snapshotIds = SnapshotIdsCopier.copy(snapshotIds);
return this;
}
@Override
@SafeVarargs
public final Builder snapshotIds(String... snapshotIds) {
snapshotIds(Arrays.asList(snapshotIds));
return this;
}
public final List getFilters() {
List result = SnapshotFiltersCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = SnapshotFiltersCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = SnapshotFiltersCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(SnapshotFilter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> SnapshotFilter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
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;
}
public final Boolean getIncludeShared() {
return includeShared;
}
public final void setIncludeShared(Boolean includeShared) {
this.includeShared = includeShared;
}
@Override
public final Builder includeShared(Boolean includeShared) {
this.includeShared = includeShared;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeSnapshotsRequest build() {
return new DescribeSnapshotsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}