com.amazonaws.services.bedrockagent.model.IngestionJobSortBy Maven / Gradle / Ivy

Go to download
/*
 * 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.bedrockagent.model;

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

/**
 * 
 * Parameters by which to sort the results.
 * 
 * 
 * @see AWS
 *      API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IngestionJobSortBy implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The attribute by which to sort the results.
     * 
     */
    private String attribute;
    /**
     * 
     * The order by which to sort the results.
     * 
     */
    private String order;

    /**
     * 
     * The attribute by which to sort the results.
     * 
     * 
     * @param attribute
     *        The attribute by which to sort the results.
     * @see IngestionJobSortByAttribute
     */

    public void setAttribute(String attribute) {
        this.attribute = attribute;
    }

    /**
     * 
     * The attribute by which to sort the results.
     * 
     * 
     * @return The attribute by which to sort the results.
     * @see IngestionJobSortByAttribute
     */

    public String getAttribute() {
        return this.attribute;
    }

    /**
     * 
     * The attribute by which to sort the results.
     * 
     * 
     * @param attribute
     *        The attribute by which to sort the results.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see IngestionJobSortByAttribute
     */

    public IngestionJobSortBy withAttribute(String attribute) {
        setAttribute(attribute);
        return this;
    }

    /**
     * 
     * The attribute by which to sort the results.
     * 
     * 
     * @param attribute
     *        The attribute by which to sort the results.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see IngestionJobSortByAttribute
     */

    public IngestionJobSortBy withAttribute(IngestionJobSortByAttribute attribute) {
        this.attribute = attribute.toString();
        return this;
    }

    /**
     * 
     * The order by which to sort the results.
     * 
     * 
     * @param order
     *        The order by which to sort the results.
     * @see SortOrder
     */

    public void setOrder(String order) {
        this.order = order;
    }

    /**
     * 
     * The order by which to sort the results.
     * 
     * 
     * @return The order by which to sort the results.
     * @see SortOrder
     */

    public String getOrder() {
        return this.order;
    }

    /**
     * 
     * The order by which to sort the results.
     * 
     * 
     * @param order
     *        The order by which to sort the results.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SortOrder
     */

    public IngestionJobSortBy withOrder(String order) {
        setOrder(order);
        return this;
    }

    /**
     * 
     * The order by which to sort the results.
     * 
     * 
     * @param order
     *        The order by which to sort the results.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SortOrder
     */

    public IngestionJobSortBy withOrder(SortOrder order) {
        this.order = order.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 (getAttribute() != null)
            sb.append("Attribute: ").append(getAttribute()).append(",");
        if (getOrder() != null)
            sb.append("Order: ").append(getOrder());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof IngestionJobSortBy == false)
            return false;
        IngestionJobSortBy other = (IngestionJobSortBy) obj;
        if (other.getAttribute() == null ^ this.getAttribute() == null)
            return false;
        if (other.getAttribute() != null && other.getAttribute().equals(this.getAttribute()) == false)
            return false;
        if (other.getOrder() == null ^ this.getOrder() == null)
            return false;
        if (other.getOrder() != null && other.getOrder().equals(this.getOrder()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getAttribute() == null) ? 0 : getAttribute().hashCode());
        hashCode = prime * hashCode + ((getOrder() == null) ? 0 : getOrder().hashCode());
        return hashCode;
    }

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