com.amazonaws.services.frauddetector.model.TFIModelPerformance Maven / Gradle / Ivy
Show all versions of aws-java-sdk-frauddetector Show documentation
/*
* 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.frauddetector.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The Transaction Fraud Insights (TFI) model performance score.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TFIModelPerformance implements Serializable, Cloneable, StructuredPojo {
/**
*
* The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR)
* across all possible model score thresholds.
*
*/
private Float auc;
/**
*
* Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates
* higher model uncertainity.
*
*/
private UncertaintyRange uncertaintyRange;
/**
*
* The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR)
* across all possible model score thresholds.
*
*
* @param auc
* The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate
* (FPR) across all possible model score thresholds.
*/
public void setAuc(Float auc) {
this.auc = auc;
}
/**
*
* The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR)
* across all possible model score thresholds.
*
*
* @return The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate
* (FPR) across all possible model score thresholds.
*/
public Float getAuc() {
return this.auc;
}
/**
*
* The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR)
* across all possible model score thresholds.
*
*
* @param auc
* The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate
* (FPR) across all possible model score thresholds.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TFIModelPerformance withAuc(Float auc) {
setAuc(auc);
return this;
}
/**
*
* Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates
* higher model uncertainity.
*
*
* @param uncertaintyRange
* Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1
* indicates higher model uncertainity.
*/
public void setUncertaintyRange(UncertaintyRange uncertaintyRange) {
this.uncertaintyRange = uncertaintyRange;
}
/**
*
* Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates
* higher model uncertainity.
*
*
* @return Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1
* indicates higher model uncertainity.
*/
public UncertaintyRange getUncertaintyRange() {
return this.uncertaintyRange;
}
/**
*
* Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates
* higher model uncertainity.
*
*
* @param uncertaintyRange
* Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1
* indicates higher model uncertainity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TFIModelPerformance withUncertaintyRange(UncertaintyRange uncertaintyRange) {
setUncertaintyRange(uncertaintyRange);
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 (getAuc() != null)
sb.append("Auc: ").append(getAuc()).append(",");
if (getUncertaintyRange() != null)
sb.append("UncertaintyRange: ").append(getUncertaintyRange());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TFIModelPerformance == false)
return false;
TFIModelPerformance other = (TFIModelPerformance) obj;
if (other.getAuc() == null ^ this.getAuc() == null)
return false;
if (other.getAuc() != null && other.getAuc().equals(this.getAuc()) == false)
return false;
if (other.getUncertaintyRange() == null ^ this.getUncertaintyRange() == null)
return false;
if (other.getUncertaintyRange() != null && other.getUncertaintyRange().equals(this.getUncertaintyRange()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAuc() == null) ? 0 : getAuc().hashCode());
hashCode = prime * hashCode + ((getUncertaintyRange() == null) ? 0 : getUncertaintyRange().hashCode());
return hashCode;
}
@Override
public TFIModelPerformance clone() {
try {
return (TFIModelPerformance) 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.frauddetector.model.transform.TFIModelPerformanceMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}