software.amazon.awssdk.services.cloudsearch.model.DescribeIndexFieldsResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudsearch Show documentation
The AWS Java SDK for Amazon CloudSearch module holds the client classes that are used for communicating with Amazon CloudSearch Service
There is a newer version: 2.29.15
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.cloudsearch.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;

/**
 * 
 * The result of a DescribeIndexFields request. Contains the index fields configured for the domain
 * specified in the request.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class DescribeIndexFieldsResponse extends CloudSearchResponse implements
        ToCopyableBuilder {
    private static final SdkField> INDEX_FIELDS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("IndexFields")
            .getter(getter(DescribeIndexFieldsResponse::indexFields))
            .setter(setter(Builder::indexFields))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexFields").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.SDK_POJO)
                                            .constructor(IndexFieldStatus::builder)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INDEX_FIELDS_FIELD));

    private final List indexFields;

    private DescribeIndexFieldsResponse(BuilderImpl builder) {
        super(builder);
        this.indexFields = builder.indexFields;
    }

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

    /**
     * 
     * The index fields configured for the domain.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasIndexFields()} to see if a value was sent in this field.
     * 
     * 
     * @return The index fields configured for the domain.
     */
    public final List indexFields() {
        return indexFields;
    }

    @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(hasIndexFields() ? indexFields() : 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 DescribeIndexFieldsResponse)) {
            return false;
        }
        DescribeIndexFieldsResponse other = (DescribeIndexFieldsResponse) obj;
        return hasIndexFields() == other.hasIndexFields() && Objects.equals(indexFields(), other.indexFields());
    }

    /**
     * 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("DescribeIndexFieldsResponse").add("IndexFields", hasIndexFields() ? indexFields() : null)
                .build();
    }

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

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

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

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

    public interface Builder extends CloudSearchResponse.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The index fields configured for the domain.
         * 
         * 
         * @param indexFields
         *        The index fields configured for the domain.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder indexFields(Collection indexFields);

        /**
         * 
         * The index fields configured for the domain.
         * 
         * 
         * @param indexFields
         *        The index fields configured for the domain.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder indexFields(IndexFieldStatus... indexFields);

        /**
         * 
         * The index fields configured for the domain.
         * 
         * 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 #indexFields(List)}.
         * 
         * @param indexFields
         *        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 #indexFields(List)
         */
        Builder indexFields(Consumer... indexFields);
    }

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

        private BuilderImpl() {
        }

        private BuilderImpl(DescribeIndexFieldsResponse model) {
            super(model);
            indexFields(model.indexFields);
        }

        public final List getIndexFields() {
            List result = IndexFieldStatusListCopier.copyToBuilder(this.indexFields);
            if (result instanceof SdkAutoConstructList) {
                return null;
            }
            return result;
        }

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

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

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

        public final void setIndexFields(Collection indexFields) {
            this.indexFields = IndexFieldStatusListCopier.copyFromBuilder(indexFields);
        }

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

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