/*
 * Copyright 2018-2023 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 com.amazonaws.services.lexmodelsv2.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * Specifies the elicitation setting details eliciting a slot.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValueElicitationSetting"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SlotValueElicitationSetting implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a
     * slot. You can specify default values from context variables, session attributes, and defined values.
     * </p>
     */
    private SlotDefaultValueSpecification defaultValueSpecification;
    /**
     * <p>
     * Specifies whether the slot is required or optional.
     * </p>
     */
    private String slotConstraint;
    /**
     * <p>
     * The prompt that Amazon Lex uses to elicit the slot value from the user.
     * </p>
     */
    private PromptSpecification promptSpecification;
    /**
     * <p>
     * If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     * provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     * understanding user utterances.
     * </p>
     */
    private java.util.List<SampleUtterance> sampleUtterances;

    private WaitAndContinueSpecification waitAndContinueSpecification;
    /**
     * <p>
     * Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     * </p>
     */
    private SlotCaptureSetting slotCaptureSetting;

    /**
     * <p>
     * A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a
     * slot. You can specify default values from context variables, session attributes, and defined values.
     * </p>
     * 
     * @param defaultValueSpecification
     *        A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for
     *        a slot. You can specify default values from context variables, session attributes, and defined values.
     */

    public void setDefaultValueSpecification(SlotDefaultValueSpecification defaultValueSpecification) {
        this.defaultValueSpecification = defaultValueSpecification;
    }

    /**
     * <p>
     * A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a
     * slot. You can specify default values from context variables, session attributes, and defined values.
     * </p>
     * 
     * @return A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value
     *         for a slot. You can specify default values from context variables, session attributes, and defined
     *         values.
     */

    public SlotDefaultValueSpecification getDefaultValueSpecification() {
        return this.defaultValueSpecification;
    }

    /**
     * <p>
     * A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a
     * slot. You can specify default values from context variables, session attributes, and defined values.
     * </p>
     * 
     * @param defaultValueSpecification
     *        A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for
     *        a slot. You can specify default values from context variables, session attributes, and defined values.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SlotValueElicitationSetting withDefaultValueSpecification(SlotDefaultValueSpecification defaultValueSpecification) {
        setDefaultValueSpecification(defaultValueSpecification);
        return this;
    }

    /**
     * <p>
     * Specifies whether the slot is required or optional.
     * </p>
     * 
     * @param slotConstraint
     *        Specifies whether the slot is required or optional.
     * @see SlotConstraint
     */

    public void setSlotConstraint(String slotConstraint) {
        this.slotConstraint = slotConstraint;
    }

    /**
     * <p>
     * Specifies whether the slot is required or optional.
     * </p>
     * 
     * @return Specifies whether the slot is required or optional.
     * @see SlotConstraint
     */

    public String getSlotConstraint() {
        return this.slotConstraint;
    }

    /**
     * <p>
     * Specifies whether the slot is required or optional.
     * </p>
     * 
     * @param slotConstraint
     *        Specifies whether the slot is required or optional.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SlotConstraint
     */

    public SlotValueElicitationSetting withSlotConstraint(String slotConstraint) {
        setSlotConstraint(slotConstraint);
        return this;
    }

    /**
     * <p>
     * Specifies whether the slot is required or optional.
     * </p>
     * 
     * @param slotConstraint
     *        Specifies whether the slot is required or optional.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SlotConstraint
     */

    public SlotValueElicitationSetting withSlotConstraint(SlotConstraint slotConstraint) {
        this.slotConstraint = slotConstraint.toString();
        return this;
    }

    /**
     * <p>
     * The prompt that Amazon Lex uses to elicit the slot value from the user.
     * </p>
     * 
     * @param promptSpecification
     *        The prompt that Amazon Lex uses to elicit the slot value from the user.
     */

    public void setPromptSpecification(PromptSpecification promptSpecification) {
        this.promptSpecification = promptSpecification;
    }

    /**
     * <p>
     * The prompt that Amazon Lex uses to elicit the slot value from the user.
     * </p>
     * 
     * @return The prompt that Amazon Lex uses to elicit the slot value from the user.
     */

    public PromptSpecification getPromptSpecification() {
        return this.promptSpecification;
    }

    /**
     * <p>
     * The prompt that Amazon Lex uses to elicit the slot value from the user.
     * </p>
     * 
     * @param promptSpecification
     *        The prompt that Amazon Lex uses to elicit the slot value from the user.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SlotValueElicitationSetting withPromptSpecification(PromptSpecification promptSpecification) {
        setPromptSpecification(promptSpecification);
        return this;
    }

    /**
     * <p>
     * If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     * provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     * understanding user utterances.
     * </p>
     * 
     * @return If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you
     *         can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable
     *         of understanding user utterances.
     */

    public java.util.List<SampleUtterance> getSampleUtterances() {
        return sampleUtterances;
    }

    /**
     * <p>
     * If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     * provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     * understanding user utterances.
     * </p>
     * 
     * @param sampleUtterances
     *        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     *        provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     *        understanding user utterances.
     */

    public void setSampleUtterances(java.util.Collection<SampleUtterance> sampleUtterances) {
        if (sampleUtterances == null) {
            this.sampleUtterances = null;
            return;
        }

        this.sampleUtterances = new java.util.ArrayList<SampleUtterance>(sampleUtterances);
    }

    /**
     * <p>
     * If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     * provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     * understanding user utterances.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setSampleUtterances(java.util.Collection)} or {@link #withSampleUtterances(java.util.Collection)} if you
     * want to override the existing values.
     * </p>
     * 
     * @param sampleUtterances
     *        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     *        provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     *        understanding user utterances.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SlotValueElicitationSetting withSampleUtterances(SampleUtterance... sampleUtterances) {
        if (this.sampleUtterances == null) {
            setSampleUtterances(new java.util.ArrayList<SampleUtterance>(sampleUtterances.length));
        }
        for (SampleUtterance ele : sampleUtterances) {
            this.sampleUtterances.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     * provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     * understanding user utterances.
     * </p>
     * 
     * @param sampleUtterances
     *        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can
     *        provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
     *        understanding user utterances.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SlotValueElicitationSetting withSampleUtterances(java.util.Collection<SampleUtterance> sampleUtterances) {
        setSampleUtterances(sampleUtterances);
        return this;
    }

    /**
     * @param waitAndContinueSpecification
     */

    public void setWaitAndContinueSpecification(WaitAndContinueSpecification waitAndContinueSpecification) {
        this.waitAndContinueSpecification = waitAndContinueSpecification;
    }

    /**
     * @return
     */

    public WaitAndContinueSpecification getWaitAndContinueSpecification() {
        return this.waitAndContinueSpecification;
    }

    /**
     * @param waitAndContinueSpecification
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SlotValueElicitationSetting withWaitAndContinueSpecification(WaitAndContinueSpecification waitAndContinueSpecification) {
        setWaitAndContinueSpecification(waitAndContinueSpecification);
        return this;
    }

    /**
     * <p>
     * Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     * </p>
     * 
     * @param slotCaptureSetting
     *        Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     */

    public void setSlotCaptureSetting(SlotCaptureSetting slotCaptureSetting) {
        this.slotCaptureSetting = slotCaptureSetting;
    }

    /**
     * <p>
     * Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     * </p>
     * 
     * @return Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     */

    public SlotCaptureSetting getSlotCaptureSetting() {
        return this.slotCaptureSetting;
    }

    /**
     * <p>
     * Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     * </p>
     * 
     * @param slotCaptureSetting
     *        Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SlotValueElicitationSetting withSlotCaptureSetting(SlotCaptureSetting slotCaptureSetting) {
        setSlotCaptureSetting(slotCaptureSetting);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getDefaultValueSpecification() != null)
            sb.append("DefaultValueSpecification: ").append(getDefaultValueSpecification()).append(",");
        if (getSlotConstraint() != null)
            sb.append("SlotConstraint: ").append(getSlotConstraint()).append(",");
        if (getPromptSpecification() != null)
            sb.append("PromptSpecification: ").append(getPromptSpecification()).append(",");
        if (getSampleUtterances() != null)
            sb.append("SampleUtterances: ").append(getSampleUtterances()).append(",");
        if (getWaitAndContinueSpecification() != null)
            sb.append("WaitAndContinueSpecification: ").append(getWaitAndContinueSpecification()).append(",");
        if (getSlotCaptureSetting() != null)
            sb.append("SlotCaptureSetting: ").append(getSlotCaptureSetting());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof SlotValueElicitationSetting == false)
            return false;
        SlotValueElicitationSetting other = (SlotValueElicitationSetting) obj;
        if (other.getDefaultValueSpecification() == null ^ this.getDefaultValueSpecification() == null)
            return false;
        if (other.getDefaultValueSpecification() != null && other.getDefaultValueSpecification().equals(this.getDefaultValueSpecification()) == false)
            return false;
        if (other.getSlotConstraint() == null ^ this.getSlotConstraint() == null)
            return false;
        if (other.getSlotConstraint() != null && other.getSlotConstraint().equals(this.getSlotConstraint()) == false)
            return false;
        if (other.getPromptSpecification() == null ^ this.getPromptSpecification() == null)
            return false;
        if (other.getPromptSpecification() != null && other.getPromptSpecification().equals(this.getPromptSpecification()) == false)
            return false;
        if (other.getSampleUtterances() == null ^ this.getSampleUtterances() == null)
            return false;
        if (other.getSampleUtterances() != null && other.getSampleUtterances().equals(this.getSampleUtterances()) == false)
            return false;
        if (other.getWaitAndContinueSpecification() == null ^ this.getWaitAndContinueSpecification() == null)
            return false;
        if (other.getWaitAndContinueSpecification() != null && other.getWaitAndContinueSpecification().equals(this.getWaitAndContinueSpecification()) == false)
            return false;
        if (other.getSlotCaptureSetting() == null ^ this.getSlotCaptureSetting() == null)
            return false;
        if (other.getSlotCaptureSetting() != null && other.getSlotCaptureSetting().equals(this.getSlotCaptureSetting()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getDefaultValueSpecification() == null) ? 0 : getDefaultValueSpecification().hashCode());
        hashCode = prime * hashCode + ((getSlotConstraint() == null) ? 0 : getSlotConstraint().hashCode());
        hashCode = prime * hashCode + ((getPromptSpecification() == null) ? 0 : getPromptSpecification().hashCode());
        hashCode = prime * hashCode + ((getSampleUtterances() == null) ? 0 : getSampleUtterances().hashCode());
        hashCode = prime * hashCode + ((getWaitAndContinueSpecification() == null) ? 0 : getWaitAndContinueSpecification().hashCode());
        hashCode = prime * hashCode + ((getSlotCaptureSetting() == null) ? 0 : getSlotCaptureSetting().hashCode());
        return hashCode;
    }

    @Override
    public SlotValueElicitationSetting clone() {
        try {
            return (SlotValueElicitationSetting) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.lexmodelsv2.model.transform.SlotValueElicitationSettingMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}