com.amazonaws.services.securityhub.model.SortCriterion Maven / Gradle / Ivy

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

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

/**
 * 
 * A collection of finding attributes used to sort findings.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SortCriterion implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The finding attribute used to sort findings.
     * 
     */
    private String field;
    /**
     * 
     * The order used to sort findings.
     * 
     */
    private String sortOrder;

    /**
     * 
     * The finding attribute used to sort findings.
     * 
     * 
     * @param field
     *        The finding attribute used to sort findings.
     */

    public void setField(String field) {
        this.field = field;
    }

    /**
     * 
     * The finding attribute used to sort findings.
     * 
     * 
     * @return The finding attribute used to sort findings.
     */

    public String getField() {
        return this.field;
    }

    /**
     * 
     * The finding attribute used to sort findings.
     * 
     * 
     * @param field
     *        The finding attribute used to sort findings.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SortCriterion withField(String field) {
        setField(field);
        return this;
    }

    /**
     * 
     * The order used to sort findings.
     * 
     * 
     * @param sortOrder
     *        The order used to sort findings.
     * @see SortOrder
     */

    public void setSortOrder(String sortOrder) {
        this.sortOrder = sortOrder;
    }

    /**
     * 
     * The order used to sort findings.
     * 
     * 
     * @return The order used to sort findings.
     * @see SortOrder
     */

    public String getSortOrder() {
        return this.sortOrder;
    }

    /**
     * 
     * The order used to sort findings.
     * 
     * 
     * @param sortOrder
     *        The order used to sort findings.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SortOrder
     */

    public SortCriterion withSortOrder(String sortOrder) {
        setSortOrder(sortOrder);
        return this;
    }

    /**
     * 
     * The order used to sort findings.
     * 
     * 
     * @param sortOrder
     *        The order used to sort findings.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SortOrder
     */

    public SortCriterion withSortOrder(SortOrder sortOrder) {
        this.sortOrder = sortOrder.toString();
        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 (getField() != null)
            sb.append("Field: ").append(getField()).append(",");
        if (getSortOrder() != null)
            sb.append("SortOrder: ").append(getSortOrder());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof SortCriterion == false)
            return false;
        SortCriterion other = (SortCriterion) obj;
        if (other.getField() == null ^ this.getField() == null)
            return false;
        if (other.getField() != null && other.getField().equals(this.getField()) == false)
            return false;
        if (other.getSortOrder() == null ^ this.getSortOrder() == null)
            return false;
        if (other.getSortOrder() != null && other.getSortOrder().equals(this.getSortOrder()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getField() == null) ? 0 : getField().hashCode());
        hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
        return hashCode;
    }

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