software.amazon.awssdk.services.lexmodelbuilding.model.BuiltinIntentMetadata Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2019 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.lexmodelbuilding.model;

import java.io.Serializable;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Provides metadata for a built-in intent.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class BuiltinIntentMetadata implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField SIGNATURE_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(BuiltinIntentMetadata::signature)).setter(setter(Builder::signature))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("signature").build()).build();

    private static final SdkField> SUPPORTED_LOCALES_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .getter(getter(BuiltinIntentMetadata::supportedLocalesAsStrings))
            .setter(setter(Builder::supportedLocalesWithStrings))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("supportedLocales").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SIGNATURE_FIELD,
            SUPPORTED_LOCALES_FIELD));

    private static final long serialVersionUID = 1L;

    private final String signature;

    private final List supportedLocales;

    private BuiltinIntentMetadata(BuilderImpl builder) {
        this.signature = builder.signature;
        this.supportedLocales = builder.supportedLocales;
    }

    /**
     * 
     * A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
     * 
     * 
     * @return A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
     */
    public String signature() {
        return signature;
    }

    /**
     * 
     * A list of identifiers for the locales that the intent supports.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * @return A list of identifiers for the locales that the intent supports.
     */
    public List supportedLocales() {
        return LocaleListCopier.copyStringToEnum(supportedLocales);
    }

    /**
     * 
     * A list of identifiers for the locales that the intent supports.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * @return A list of identifiers for the locales that the intent supports.
     */
    public List supportedLocalesAsStrings() {
        return supportedLocales;
    }

    @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 + Objects.hashCode(signature());
        hashCode = 31 * hashCode + Objects.hashCode(supportedLocalesAsStrings());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof BuiltinIntentMetadata)) {
            return false;
        }
        BuiltinIntentMetadata other = (BuiltinIntentMetadata) obj;
        return Objects.equals(signature(), other.signature())
                && Objects.equals(supportedLocalesAsStrings(), other.supportedLocalesAsStrings());
    }

    /**
     * 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("BuiltinIntentMetadata").add("Signature", signature())
                .add("SupportedLocales", supportedLocalesAsStrings()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "signature":
            return Optional.ofNullable(clazz.cast(signature()));
        case "supportedLocales":
            return Optional.ofNullable(clazz.cast(supportedLocalesAsStrings()));
        default:
            return Optional.empty();
        }
    }

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
         * 
         * 
         * @param signature
         *        A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder signature(String signature);

        /**
         * 
         * A list of identifiers for the locales that the intent supports.
         * 
         * 
         * @param supportedLocales
         *        A list of identifiers for the locales that the intent supports.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder supportedLocalesWithStrings(Collection supportedLocales);

        /**
         * 
         * A list of identifiers for the locales that the intent supports.
         * 
         * 
         * @param supportedLocales
         *        A list of identifiers for the locales that the intent supports.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder supportedLocalesWithStrings(String... supportedLocales);

        /**
         * 
         * A list of identifiers for the locales that the intent supports.
         * 
         * 
         * @param supportedLocales
         *        A list of identifiers for the locales that the intent supports.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder supportedLocales(Collection supportedLocales);

        /**
         * 
         * A list of identifiers for the locales that the intent supports.
         * 
         * 
         * @param supportedLocales
         *        A list of identifiers for the locales that the intent supports.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder supportedLocales(Locale... supportedLocales);
    }

    static final class BuilderImpl implements Builder {
        private String signature;

        private List supportedLocales = DefaultSdkAutoConstructList.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(BuiltinIntentMetadata model) {
            signature(model.signature);
            supportedLocalesWithStrings(model.supportedLocales);
        }

        public final String getSignature() {
            return signature;
        }

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

        public final void setSignature(String signature) {
            this.signature = signature;
        }

        public final Collection getSupportedLocalesAsStrings() {
            return supportedLocales;
        }

        @Override
        public final Builder supportedLocalesWithStrings(Collection supportedLocales) {
            this.supportedLocales = LocaleListCopier.copy(supportedLocales);
            return this;
        }

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

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

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

        public final void setSupportedLocalesWithStrings(Collection supportedLocales) {
            this.supportedLocales = LocaleListCopier.copy(supportedLocales);
        }

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

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