software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sqs Show documentation
The AWS Java SDK for Amazon SQS module holds the client classes that are used for communicating with Amazon Simple Queue 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.sqs.model;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;

/**
 * 
 * A list of your dead letter source queues.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class ListDeadLetterSourceQueuesResponse extends SqsResponse implements
        ToCopyableBuilder {
    private static final SdkField> QUEUE_URLS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("queueUrls")
            .getter(getter(ListDeadLetterSourceQueuesResponse::queueUrls))
            .setter(setter(Builder::queueUrls))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("queueUrls").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.STRING)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).isFlattened(true).build()).build();

    private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("NextToken").getter(getter(ListDeadLetterSourceQueuesResponse::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(QUEUE_URLS_FIELD,
            NEXT_TOKEN_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = Collections
            .unmodifiableMap(new HashMap>() {
                {
                    put("queueUrls", QUEUE_URLS_FIELD);
                    put("NextToken", NEXT_TOKEN_FIELD);
                }
            });

    private final List queueUrls;

    private final String nextToken;

    private ListDeadLetterSourceQueuesResponse(BuilderImpl builder) {
        super(builder);
        this.queueUrls = builder.queueUrls;
        this.nextToken = builder.nextToken;
    }

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

    /**
     * 
     * A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
     * dead-letter queue.
     * 
     * 
     * 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 #hasQueueUrls} method.
     * 
     * 
     * @return A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
     *         dead-letter queue.
     */
    public final List queueUrls() {
        return queueUrls;
    }

    /**
     * 
     * Pagination token to include in the next request. Token value is null if there are no additional
     * results to request, or if you did not set MaxResults in the request.
     * 
     * 
     * @return Pagination token to include in the next request. Token value is null if there are no
     *         additional results to request, or if you did not set MaxResults in the request.
     */
    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(hasQueueUrls() ? queueUrls() : 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 ListDeadLetterSourceQueuesResponse)) {
            return false;
        }
        ListDeadLetterSourceQueuesResponse other = (ListDeadLetterSourceQueuesResponse) obj;
        return hasQueueUrls() == other.hasQueueUrls() && Objects.equals(queueUrls(), other.queueUrls())
                && 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("ListDeadLetterSourceQueuesResponse").add("QueueUrls", hasQueueUrls() ? queueUrls() : null)
                .add("NextToken", nextToken()).build();
    }

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

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

    @Override
    public final Map> sdkFieldNameToField() {
        return SDK_NAME_TO_FIELD;
    }

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

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

    public interface Builder extends SqsResponse.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
         * dead-letter queue.
         * 
         * 
         * @param queueUrls
         *        A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
         *        dead-letter queue.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueUrls(Collection queueUrls);

        /**
         * 
         * A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
         * dead-letter queue.
         * 
         * 
         * @param queueUrls
         *        A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
         *        dead-letter queue.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueUrls(String... queueUrls);

        /**
         * 
         * Pagination token to include in the next request. Token value is null if there are no additional
         * results to request, or if you did not set MaxResults in the request.
         * 
         * 
         * @param nextToken
         *        Pagination token to include in the next request. Token value is null if there are no
         *        additional results to request, or if you did not set MaxResults in the request.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder nextToken(String nextToken);
    }

    static final class BuilderImpl extends SqsResponse.BuilderImpl implements Builder {
        private List queueUrls = DefaultSdkAutoConstructList.getInstance();

        private String nextToken;

        private BuilderImpl() {
        }

        private BuilderImpl(ListDeadLetterSourceQueuesResponse model) {
            super(model);
            queueUrls(model.queueUrls);
            nextToken(model.nextToken);
        }

        public final Collection getQueueUrls() {
            if (queueUrls instanceof SdkAutoConstructList) {
                return null;
            }
            return queueUrls;
        }

        public final void setQueueUrls(Collection queueUrls) {
            this.queueUrls = QueueUrlListCopier.copy(queueUrls);
        }

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

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

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

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}