com.amazonaws.services.macie2.model.SortCriteria Maven / Gradle / Ivy
Show all versions of aws-java-sdk-macie2 Show documentation
/*
* 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.macie2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies criteria for sorting the results of a request for findings.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SortCriteria implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected,
* severity.score, type, and updatedAt.
*
*/
private String attributeName;
/**
*
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending
* order.
*
*/
private String orderBy;
/**
*
* The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected,
* severity.score, type, and updatedAt.
*
*
* @param attributeName
* The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen,
* resourcesAffected, severity.score, type, and updatedAt.
*/
public void setAttributeName(String attributeName) {
this.attributeName = attributeName;
}
/**
*
* The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected,
* severity.score, type, and updatedAt.
*
*
* @return The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen,
* resourcesAffected, severity.score, type, and updatedAt.
*/
public String getAttributeName() {
return this.attributeName;
}
/**
*
* The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected,
* severity.score, type, and updatedAt.
*
*
* @param attributeName
* The name of the property to sort the results by. Valid values are: count, createdAt,
* policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen,
* resourcesAffected, severity.score, type, and updatedAt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SortCriteria withAttributeName(String attributeName) {
setAttributeName(attributeName);
return this;
}
/**
*
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending
* order.
*
*
* @param orderBy
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in
* descending order.
* @see OrderBy
*/
public void setOrderBy(String orderBy) {
this.orderBy = orderBy;
}
/**
*
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending
* order.
*
*
* @return The sort order to apply to the results, based on the value for the property specified by the
* attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the
* results in descending order.
* @see OrderBy
*/
public String getOrderBy() {
return this.orderBy;
}
/**
*
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending
* order.
*
*
* @param orderBy
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in
* descending order.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrderBy
*/
public SortCriteria withOrderBy(String orderBy) {
setOrderBy(orderBy);
return this;
}
/**
*
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending
* order.
*
*
* @param orderBy
* The sort order to apply to the results, based on the value for the property specified by the attributeName
* property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in
* descending order.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrderBy
*/
public SortCriteria withOrderBy(OrderBy orderBy) {
this.orderBy = orderBy.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 (getAttributeName() != null)
sb.append("AttributeName: ").append(getAttributeName()).append(",");
if (getOrderBy() != null)
sb.append("OrderBy: ").append(getOrderBy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SortCriteria == false)
return false;
SortCriteria other = (SortCriteria) obj;
if (other.getAttributeName() == null ^ this.getAttributeName() == null)
return false;
if (other.getAttributeName() != null && other.getAttributeName().equals(this.getAttributeName()) == false)
return false;
if (other.getOrderBy() == null ^ this.getOrderBy() == null)
return false;
if (other.getOrderBy() != null && other.getOrderBy().equals(this.getOrderBy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAttributeName() == null) ? 0 : getAttributeName().hashCode());
hashCode = prime * hashCode + ((getOrderBy() == null) ? 0 : getOrderBy().hashCode());
return hashCode;
}
@Override
public SortCriteria clone() {
try {
return (SortCriteria) 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.macie2.model.transform.SortCriteriaMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}