software.amazon.awssdk.services.connect.model.ListQueuesRequest Maven / Gradle / Ivy

Go to download
/*
 * 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.connect.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 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 ListQueuesRequest extends ConnectRequest implements
        ToCopyableBuilder {
    private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(ListQueuesRequest::instanceId)).setter(setter(Builder::instanceId))
            .traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();

    private static final SdkField> QUEUE_TYPES_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .getter(getter(ListQueuesRequest::queueTypesAsStrings))
            .setter(setter(Builder::queueTypesWithStrings))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("queueTypes").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)
            .getter(getter(ListQueuesRequest::nextToken)).setter(setter(Builder::nextToken))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();

    private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .getter(getter(ListQueuesRequest::maxResults)).setter(setter(Builder::maxResults))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();

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

    private final String instanceId;

    private final List queueTypes;

    private final String nextToken;

    private final Integer maxResults;

    private ListQueuesRequest(BuilderImpl builder) {
        super(builder);
        this.instanceId = builder.instanceId;
        this.queueTypes = builder.queueTypes;
        this.nextToken = builder.nextToken;
        this.maxResults = builder.maxResults;
    }

    /**
     * 
     * The identifier of the Amazon Connect instance.
     * 
     * 
     * @return The identifier of the Amazon Connect instance.
     */
    public String instanceId() {
        return instanceId;
    }

    /**
     * 
     * The type of queue.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasQueueTypes()} to see if a value was sent in this field.
     * 
     * 
     * @return The type of queue.
     */
    public List queueTypes() {
        return QueueTypesCopier.copyStringToEnum(queueTypes);
    }

    /**
     * Returns true if the QueueTypes 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 hasQueueTypes() {
        return queueTypes != null && !(queueTypes instanceof SdkAutoConstructList);
    }

    /**
     * 
     * The type of queue.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasQueueTypes()} to see if a value was sent in this field.
     * 
     * 
     * @return The type of queue.
     */
    public List queueTypesAsStrings() {
        return queueTypes;
    }

    /**
     * 
     * The token for the next set of results. Use the value returned in the previous response in the next request to
     * retrieve the next set of results.
     * 
     * 
     * @return The token for the next set of results. Use the value returned in the previous response in the next
     *         request to retrieve the next set of results.
     */
    public String nextToken() {
        return nextToken;
    }

    /**
     * 
     * The maximimum number of results to return per page.
     * 
     * 
     * @return The maximimum number of results to return per page.
     */
    public Integer maxResults() {
        return maxResults;
    }

    @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(instanceId());
        hashCode = 31 * hashCode + Objects.hashCode(queueTypesAsStrings());
        hashCode = 31 * hashCode + Objects.hashCode(nextToken());
        hashCode = 31 * hashCode + Objects.hashCode(maxResults());
        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 ListQueuesRequest)) {
            return false;
        }
        ListQueuesRequest other = (ListQueuesRequest) obj;
        return Objects.equals(instanceId(), other.instanceId())
                && Objects.equals(queueTypesAsStrings(), other.queueTypesAsStrings())
                && Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
    }

    /**
     * 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("ListQueuesRequest").add("InstanceId", instanceId()).add("QueueTypes", queueTypesAsStrings())
                .add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "InstanceId":
            return Optional.ofNullable(clazz.cast(instanceId()));
        case "QueueTypes":
            return Optional.ofNullable(clazz.cast(queueTypesAsStrings()));
        case "NextToken":
            return Optional.ofNullable(clazz.cast(nextToken()));
        case "MaxResults":
            return Optional.ofNullable(clazz.cast(maxResults()));
        default:
            return Optional.empty();
        }
    }

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

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

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

    public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The identifier of the Amazon Connect instance.
         * 
         * 
         * @param instanceId
         *        The identifier of the Amazon Connect instance.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder instanceId(String instanceId);

        /**
         * 
         * The type of queue.
         * 
         * 
         * @param queueTypes
         *        The type of queue.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueTypesWithStrings(Collection queueTypes);

        /**
         * 
         * The type of queue.
         * 
         * 
         * @param queueTypes
         *        The type of queue.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueTypesWithStrings(String... queueTypes);

        /**
         * 
         * The type of queue.
         * 
         * 
         * @param queueTypes
         *        The type of queue.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueTypes(Collection queueTypes);

        /**
         * 
         * The type of queue.
         * 
         * 
         * @param queueTypes
         *        The type of queue.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueTypes(QueueType... queueTypes);

        /**
         * 
         * The token for the next set of results. Use the value returned in the previous response in the next request to
         * retrieve the next set of results.
         * 
         * 
         * @param nextToken
         *        The token for the next set of results. Use the value returned in the previous response in the next
         *        request to retrieve the next set of results.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder nextToken(String nextToken);

        /**
         * 
         * The maximimum number of results to return per page.
         * 
         * 
         * @param maxResults
         *        The maximimum number of results to return per page.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder maxResults(Integer maxResults);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
        private String instanceId;

        private List queueTypes = DefaultSdkAutoConstructList.getInstance();

        private String nextToken;

        private Integer maxResults;

        private BuilderImpl() {
        }

        private BuilderImpl(ListQueuesRequest model) {
            super(model);
            instanceId(model.instanceId);
            queueTypesWithStrings(model.queueTypes);
            nextToken(model.nextToken);
            maxResults(model.maxResults);
        }

        public final String getInstanceId() {
            return instanceId;
        }

        @Override
        public final Builder instanceId(String instanceId) {
            this.instanceId = instanceId;
            return this;
        }

        public final void setInstanceId(String instanceId) {
            this.instanceId = instanceId;
        }

        public final Collection getQueueTypes() {
            return queueTypes;
        }

        @Override
        public final Builder queueTypesWithStrings(Collection queueTypes) {
            this.queueTypes = QueueTypesCopier.copy(queueTypes);
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder queueTypesWithStrings(String... queueTypes) {
            queueTypesWithStrings(Arrays.asList(queueTypes));
            return this;
        }

        @Override
        public final Builder queueTypes(Collection queueTypes) {
            this.queueTypes = QueueTypesCopier.copyEnumToString(queueTypes);
            return this;
        }

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

        public final void setQueueTypes(Collection queueTypes) {
            this.queueTypes = QueueTypesCopier.copy(queueTypes);
        }

        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 Integer getMaxResults() {
            return maxResults;
        }

        @Override
        public final Builder maxResults(Integer maxResults) {
            this.maxResults = maxResults;
            return this;
        }

        public final void setMaxResults(Integer maxResults) {
            this.maxResults = maxResults;
        }

        @Override
        public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
            super.overrideConfiguration(overrideConfiguration);
            return this;
        }

        @Override
        public Builder overrideConfiguration(Consumer builderConsumer) {
            super.overrideConfiguration(builderConsumer);
            return this;
        }

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

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