All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.ec2.model.DescribeSnapshotsResponse 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.ec2.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 DescribeSnapshotsResponse extends Ec2Response implements
        ToCopyableBuilder {
    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("SnapshotSet")
                    .unmarshallLocationName("snapshotSet").build(),
                    ListTrait
                            .builder()
                            .memberLocationName("item")
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.SDK_POJO)
                                            .constructor(Snapshot::builder)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("Item").unmarshallLocationName("item").build()).build())
                            .build()).build();

    private static final SdkField NEXT_TOKEN_FIELD = SdkField
            . builder(MarshallingType.STRING)
            .memberName("NextToken")
            .getter(getter(DescribeSnapshotsResponse::nextToken))
            .setter(setter(Builder::nextToken))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken")
                    .unmarshallLocationName("nextToken").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SNAPSHOTS_FIELD,
            NEXT_TOKEN_FIELD));

    private final List snapshots;

    private final String nextToken;

    private DescribeSnapshotsResponse(BuilderImpl builder) {
        super(builder);
        this.snapshots = builder.snapshots;
        this.nextToken = builder.nextToken;
    }

    /**
     * Returns true if the Snapshots property was specified by the sender (it may be empty), or false if the sender did
     * not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
     */
    public boolean hasSnapshots() {
        return snapshots != null && !(snapshots instanceof SdkAutoConstructList);
    }

    /**
     * 

* Information about the snapshots. *

*

* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException. *

*

* You can use {@link #hasSnapshots()} to see if a value was sent in this field. *

* * @return Information about the snapshots. */ public List snapshots() { return snapshots; } /** *

* The NextToken value to include in a future DescribeSnapshots request. When the results * of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve * the next page of results. This value is null when there are no more results to return. *

* * @return The NextToken value to include in a future DescribeSnapshots request. When the * results of a DescribeSnapshots request exceed MaxResults, this value can be * used to retrieve the next page of results. This value is null when there are no more results * to return. */ public 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 int hashCode() { int hashCode = 1; hashCode = 31 * hashCode + super.hashCode(); hashCode = 31 * hashCode + Objects.hashCode(snapshots()); hashCode = 31 * hashCode + Objects.hashCode(nextToken()); return hashCode; } @Override public boolean equals(Object obj) { return super.equals(obj) && equalsBySdkFields(obj); } @Override public 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(snapshots(), other.snapshots()) && 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 String toString() { return ToString.builder("DescribeSnapshotsResponse").add("Snapshots", snapshots()).add("NextToken", nextToken()).build(); } public Optional getValueForField(String fieldName, Class clazz) { switch (fieldName) { case "Snapshots": return Optional.ofNullable(clazz.cast(snapshots())); case "NextToken": return Optional.ofNullable(clazz.cast(nextToken())); default: return Optional.empty(); } } @Override public 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 Ec2Response.Builder, SdkPojo, CopyableBuilder { /** *

* Information about the snapshots. *

* * @param snapshots * Information about the snapshots. * @return Returns a reference to this object so that method calls can be chained together. */ Builder snapshots(Collection snapshots); /** *

* Information about the snapshots. *

* * @param snapshots * Information about the snapshots. * @return Returns a reference to this object so that method calls can be chained together. */ Builder snapshots(Snapshot... snapshots); /** *

* Information about the snapshots. *

* 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 #snapshots(List)}. * * @param snapshots * 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 #snapshots(List) */ Builder snapshots(Consumer... snapshots); /** *

* The NextToken value to include in a future DescribeSnapshots request. When the * results of a DescribeSnapshots request exceed MaxResults, this value can be used to * retrieve the next page of results. This value is null when there are no more results to return. *

* * @param nextToken * The NextToken value to include in a future DescribeSnapshots request. When * the results of a DescribeSnapshots request exceed MaxResults, this value can * be used to retrieve the next page of results. This value is null when there are no more * results to return. * @return Returns a reference to this object so that method calls can be chained together. */ Builder nextToken(String nextToken); } static final class BuilderImpl extends Ec2Response.BuilderImpl implements Builder { private List snapshots = DefaultSdkAutoConstructList.getInstance(); private String nextToken; private BuilderImpl() { } private BuilderImpl(DescribeSnapshotsResponse model) { super(model); snapshots(model.snapshots); nextToken(model.nextToken); } public final Collection getSnapshots() { return snapshots != null ? snapshots.stream().map(Snapshot::toBuilder).collect(Collectors.toList()) : null; } @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; } public final void setSnapshots(Collection snapshots) { this.snapshots = SnapshotListCopier.copyFromBuilder(snapshots); } public final String getNextToken() { return nextToken; } @Override public final Builder nextToken(String nextToken) { this.nextToken = nextToken; return this; } public final void setNextToken(String nextToken) { this.nextToken = nextToken; } @Override public DescribeSnapshotsResponse build() { return new DescribeSnapshotsResponse(this); } @Override public List> sdkFields() { return SDK_FIELDS; } } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy