software.amazon.awssdk.services.transfer.model.ListServersResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfer Show documentation
The AWS Java SDK for Transfer module holds the client classes that are used for communicating with Transfer.
There is a newer version: 2.29.39
/*
 * 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.transfer.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 ListServersResponse extends TransferResponse implements
        ToCopyableBuilder {
    private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("NextToken").getter(getter(ListServersResponse::nextToken)).setter(setter(Builder::nextToken))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();

    private static final SdkField> SERVERS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("Servers")
            .getter(getter(ListServersResponse::servers))
            .setter(setter(Builder::servers))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Servers").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.SDK_POJO)
                                            .constructor(ListedServer::builder)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

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

    private final String nextToken;

    private final List servers;

    private ListServersResponse(BuilderImpl builder) {
        super(builder);
        this.nextToken = builder.nextToken;
        this.servers = builder.servers;
    }

    /**
     * 
     * When you can get additional results from the ListServers operation, a NextToken
     * parameter is returned in the output. In a following command, you can pass in the NextToken parameter
     * to continue listing additional servers.
     * 
     * 
     * @return When you can get additional results from the ListServers operation, a NextToken
     *         parameter is returned in the output. In a following command, you can pass in the NextToken
     *         parameter to continue listing additional servers.
     */
    public final String nextToken() {
        return nextToken;
    }

    /**
     * Returns true if the Servers 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 final boolean hasServers() {
        return servers != null && !(servers instanceof SdkAutoConstructList);
    }

    /**
     * 
     * An array of servers that were listed.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasServers()} to see if a value was sent in this field.
     * 
     * 
     * @return An array of servers that were listed.
     */
    public final List servers() {
        return servers;
    }

    @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(nextToken());
        hashCode = 31 * hashCode + Objects.hashCode(hasServers() ? servers() : null);
        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 ListServersResponse)) {
            return false;
        }
        ListServersResponse other = (ListServersResponse) obj;
        return Objects.equals(nextToken(), other.nextToken()) && hasServers() == other.hasServers()
                && Objects.equals(servers(), other.servers());
    }

    /**
     * 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("ListServersResponse").add("NextToken", nextToken())
                .add("Servers", hasServers() ? servers() : null).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "NextToken":
            return Optional.ofNullable(clazz.cast(nextToken()));
        case "Servers":
            return Optional.ofNullable(clazz.cast(servers()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((ListServersResponse) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends TransferResponse.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * When you can get additional results from the ListServers operation, a NextToken
         * parameter is returned in the output. In a following command, you can pass in the NextToken
         * parameter to continue listing additional servers.
         * 
         * 
         * @param nextToken
         *        When you can get additional results from the ListServers operation, a
         *        NextToken parameter is returned in the output. In a following command, you can pass in
         *        the NextToken parameter to continue listing additional servers.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder nextToken(String nextToken);

        /**
         * 
         * An array of servers that were listed.
         * 
         * 
         * @param servers
         *        An array of servers that were listed.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder servers(Collection servers);

        /**
         * 
         * An array of servers that were listed.
         * 
         * 
         * @param servers
         *        An array of servers that were listed.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder servers(ListedServer... servers);

        /**
         * 
         * An array of servers that were listed.
         * 
         * 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 #servers(List)}.
         * 
         * @param servers
         *        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 #servers(List)
         */
        Builder servers(Consumer... servers);
    }

    static final class BuilderImpl extends TransferResponse.BuilderImpl implements Builder {
        private String nextToken;

        private List servers = DefaultSdkAutoConstructList.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(ListServersResponse model) {
            super(model);
            nextToken(model.nextToken);
            servers(model.servers);
        }

        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;
        }

        public final List getServers() {
            List result = ListedServersCopier.copyToBuilder(this.servers);
            if (result instanceof SdkAutoConstructList) {
                return null;
            }
            return result;
        }

        @Override
        public final Builder servers(Collection servers) {
            this.servers = ListedServersCopier.copy(servers);
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder servers(ListedServer... servers) {
            servers(Arrays.asList(servers));
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder servers(Consumer... servers) {
            servers(Stream.of(servers).map(c -> ListedServer.builder().applyMutation(c).build()).collect(Collectors.toList()));
            return this;
        }

        public final void setServers(Collection servers) {
            this.servers = ListedServersCopier.copyFromBuilder(servers);
        }

        @Override
        public ListServersResponse build() {
            return new ListServersResponse(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}