com.amazonaws.services.kendra.model.DocumentAttributeValueCountPair Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2021 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.kendra.model;

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

/**
 * 
 * Provides the count of documents that match a particular attribute when doing a faceted search.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DocumentAttributeValueCountPair implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The value of the attribute. For example, "HR."
     * 
     */
    private DocumentAttributeValue documentAttributeValue;
    /**
     * 
     * The number of documents in the response that have the attribute value for the key.
     * 
     */
    private Integer count;

    /**
     * 
     * The value of the attribute. For example, "HR."
     * 
     * 
     * @param documentAttributeValue
     *        The value of the attribute. For example, "HR."
     */

    public void setDocumentAttributeValue(DocumentAttributeValue documentAttributeValue) {
        this.documentAttributeValue = documentAttributeValue;
    }

    /**
     * 
     * The value of the attribute. For example, "HR."
     * 
     * 
     * @return The value of the attribute. For example, "HR."
     */

    public DocumentAttributeValue getDocumentAttributeValue() {
        return this.documentAttributeValue;
    }

    /**
     * 
     * The value of the attribute. For example, "HR."
     * 
     * 
     * @param documentAttributeValue
     *        The value of the attribute. For example, "HR."
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DocumentAttributeValueCountPair withDocumentAttributeValue(DocumentAttributeValue documentAttributeValue) {
        setDocumentAttributeValue(documentAttributeValue);
        return this;
    }

    /**
     * 
     * The number of documents in the response that have the attribute value for the key.
     * 
     * 
     * @param count
     *        The number of documents in the response that have the attribute value for the key.
     */

    public void setCount(Integer count) {
        this.count = count;
    }

    /**
     * 
     * The number of documents in the response that have the attribute value for the key.
     * 
     * 
     * @return The number of documents in the response that have the attribute value for the key.
     */

    public Integer getCount() {
        return this.count;
    }

    /**
     * 
     * The number of documents in the response that have the attribute value for the key.
     * 
     * 
     * @param count
     *        The number of documents in the response that have the attribute value for the key.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DocumentAttributeValueCountPair withCount(Integer count) {
        setCount(count);
        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 (getDocumentAttributeValue() != null)
            sb.append("DocumentAttributeValue: ").append(getDocumentAttributeValue()).append(",");
        if (getCount() != null)
            sb.append("Count: ").append(getCount());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof DocumentAttributeValueCountPair == false)
            return false;
        DocumentAttributeValueCountPair other = (DocumentAttributeValueCountPair) obj;
        if (other.getDocumentAttributeValue() == null ^ this.getDocumentAttributeValue() == null)
            return false;
        if (other.getDocumentAttributeValue() != null && other.getDocumentAttributeValue().equals(this.getDocumentAttributeValue()) == false)
            return false;
        if (other.getCount() == null ^ this.getCount() == null)
            return false;
        if (other.getCount() != null && other.getCount().equals(this.getCount()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getDocumentAttributeValue() == null) ? 0 : getDocumentAttributeValue().hashCode());
        hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode());
        return hashCode;
    }

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