com.amazonaws.services.customerprofiles.model.AdditionalSearchKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-customerprofiles Show documentation
The AWS Java SDK for Amazon Connect Customer Profiles module holds the client classes that are used for communicating with Amazon Connect Customer Profiles Service
The newest version!
/*
 * Copyright 2019-2024 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.customerprofiles.model;

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

/**
 * 
 * A data type pair that consists of a KeyName and Values list that is used in conjunction
 * with the KeyName and Values parameters to search for profiles using the SearchProfiles
 * API.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AdditionalSearchKey implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * A searchable identifier of a customer profile.
     * 
     */
    private String keyName;
    /**
     * 
     * A list of key values.
     * 
     */
    private java.util.List values;

    /**
     * 
     * A searchable identifier of a customer profile.
     * 
     * 
     * @param keyName
     *        A searchable identifier of a customer profile.
     */

    public void setKeyName(String keyName) {
        this.keyName = keyName;
    }

    /**
     * 
     * A searchable identifier of a customer profile.
     * 
     * 
     * @return A searchable identifier of a customer profile.
     */

    public String getKeyName() {
        return this.keyName;
    }

    /**
     * 
     * A searchable identifier of a customer profile.
     * 
     * 
     * @param keyName
     *        A searchable identifier of a customer profile.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public AdditionalSearchKey withKeyName(String keyName) {
        setKeyName(keyName);
        return this;
    }

    /**
     * 
     * A list of key values.
     * 
     * 
     * @return A list of key values.
     */

    public java.util.List getValues() {
        return values;
    }

    /**
     * 
     * A list of key values.
     * 
     * 
     * @param values
     *        A list of key values.
     */

    public void setValues(java.util.Collection values) {
        if (values == null) {
            this.values = null;
            return;
        }

        this.values = new java.util.ArrayList(values);
    }

    /**
     * 
     * A list of key values.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param values
     *        A list of key values.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public AdditionalSearchKey withValues(String... values) {
        if (this.values == null) {
            setValues(new java.util.ArrayList(values.length));
        }
        for (String ele : values) {
            this.values.add(ele);
        }
        return this;
    }

    /**
     * 
     * A list of key values.
     * 
     * 
     * @param values
     *        A list of key values.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public AdditionalSearchKey withValues(java.util.Collection values) {
        setValues(values);
        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 (getKeyName() != null)
            sb.append("KeyName: ").append(getKeyName()).append(",");
        if (getValues() != null)
            sb.append("Values: ").append(getValues());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof AdditionalSearchKey == false)
            return false;
        AdditionalSearchKey other = (AdditionalSearchKey) obj;
        if (other.getKeyName() == null ^ this.getKeyName() == null)
            return false;
        if (other.getKeyName() != null && other.getKeyName().equals(this.getKeyName()) == false)
            return false;
        if (other.getValues() == null ^ this.getValues() == null)
            return false;
        if (other.getValues() != null && other.getValues().equals(this.getValues()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getKeyName() == null) ? 0 : getKeyName().hashCode());
        hashCode = prime * hashCode + ((getValues() == null) ? 0 : getValues().hashCode());
        return hashCode;
    }

    @Override
    public AdditionalSearchKey clone() {
        try {
            return (AdditionalSearchKey) 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.customerprofiles.model.transform.AdditionalSearchKeyMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}