software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ecs Show documentation
The AWS Java SDK for the Amazon EC2 Container Service holds the client classes that are used for communicating with the Amazon EC2 Container Service
There is a newer version: 2.29.39
Show newest version
/*
 * 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.ecs.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.Function;
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 ListContainerInstancesResponse extends EcsResponse implements
        ToCopyableBuilder {
    private static final SdkField> CONTAINER_INSTANCE_ARNS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("containerInstanceArns")
            .getter(getter(ListContainerInstancesResponse::containerInstanceArns))
            .setter(setter(Builder::containerInstanceArns))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("containerInstanceArns").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 NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("nextToken").getter(getter(ListContainerInstancesResponse::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(CONTAINER_INSTANCE_ARNS_FIELD,
            NEXT_TOKEN_FIELD));

    private final List containerInstanceArns;

    private final String nextToken;

    private ListContainerInstancesResponse(BuilderImpl builder) {
        super(builder);
        this.containerInstanceArns = builder.containerInstanceArns;
        this.nextToken = builder.nextToken;
    }

    /**
     * For responses, this returns true if the service returned a value for the ContainerInstanceArns 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 hasContainerInstanceArns() {
        return containerInstanceArns != null && !(containerInstanceArns instanceof SdkAutoConstructList);
    }

    /**
     * 
     * The list of container instances with full ARN entries for each container instance associated with the specified
     * cluster.
     * 
     * 
     * 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 #hasContainerInstanceArns} method.
     * 
     * 
     * @return The list of container instances with full ARN entries for each container instance associated with the
     *         specified cluster.
     */
    public final List containerInstanceArns() {
        return containerInstanceArns;
    }

    /**
     * 
     * The nextToken value to include in a future ListContainerInstances request. When the
     * results of a ListContainerInstances 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 ListContainerInstances request. When
     *         the results of a ListContainerInstances 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 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(hasContainerInstanceArns() ? containerInstanceArns() : 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 ListContainerInstancesResponse)) {
            return false;
        }
        ListContainerInstancesResponse other = (ListContainerInstancesResponse) obj;
        return hasContainerInstanceArns() == other.hasContainerInstanceArns()
                && Objects.equals(containerInstanceArns(), other.containerInstanceArns())
                && 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("ListContainerInstancesResponse")
                .add("ContainerInstanceArns", hasContainerInstanceArns() ? containerInstanceArns() : null)
                .add("NextToken", nextToken()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "containerInstanceArns":
            return Optional.ofNullable(clazz.cast(containerInstanceArns()));
        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((ListContainerInstancesResponse) obj);
    }

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

    public interface Builder extends EcsResponse.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The list of container instances with full ARN entries for each container instance associated with the
         * specified cluster.
         * 
         * 
         * @param containerInstanceArns
         *        The list of container instances with full ARN entries for each container instance associated with the
         *        specified cluster.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder containerInstanceArns(Collection containerInstanceArns);

        /**
         * 
         * The list of container instances with full ARN entries for each container instance associated with the
         * specified cluster.
         * 
         * 
         * @param containerInstanceArns
         *        The list of container instances with full ARN entries for each container instance associated with the
         *        specified cluster.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder containerInstanceArns(String... containerInstanceArns);

        /**
         * 
         * The nextToken value to include in a future ListContainerInstances request. When the
         * results of a ListContainerInstances 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 ListContainerInstances request.
         *        When the results of a ListContainerInstances 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 EcsResponse.BuilderImpl implements Builder {
        private List containerInstanceArns = DefaultSdkAutoConstructList.getInstance();

        private String nextToken;

        private BuilderImpl() {
        }

        private BuilderImpl(ListContainerInstancesResponse model) {
            super(model);
            containerInstanceArns(model.containerInstanceArns);
            nextToken(model.nextToken);
        }

        public final Collection getContainerInstanceArns() {
            if (containerInstanceArns instanceof SdkAutoConstructList) {
                return null;
            }
            return containerInstanceArns;
        }

        public final void setContainerInstanceArns(Collection containerInstanceArns) {
            this.containerInstanceArns = StringListCopier.copy(containerInstanceArns);
        }

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

        @Override
        @SafeVarargs
        public final Builder containerInstanceArns(String... containerInstanceArns) {
            containerInstanceArns(Arrays.asList(containerInstanceArns));
            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 ListContainerInstancesResponse build() {
            return new ListContainerInstancesResponse(this);
        }

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