com.amazonaws.services.sagemaker.model.RecommendationMetrics Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The metrics of recommendations.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RecommendationMetrics implements Serializable, Cloneable, StructuredPojo {
/**
*
* Defines the cost per hour for the instance.
*
*/
private Float costPerHour;
/**
*
* Defines the cost per inference for the instance .
*
*/
private Float costPerInference;
/**
*
* The expected maximum number of requests per minute for the instance.
*
*/
private Integer maxInvocations;
/**
*
* The expected model latency at maximum invocation per minute for the instance.
*
*/
private Integer modelLatency;
/**
*
* The expected CPU utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*/
private Float cpuUtilization;
/**
*
* The expected memory utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*/
private Float memoryUtilization;
/**
*
* The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the
* model size, how long it takes to download the model, and the start-up time of the container.
*
*
* NaN indicates that the value is not available.
*
*/
private Integer modelSetupTime;
/**
*
* Defines the cost per hour for the instance.
*
*
* @param costPerHour
* Defines the cost per hour for the instance.
*/
public void setCostPerHour(Float costPerHour) {
this.costPerHour = costPerHour;
}
/**
*
* Defines the cost per hour for the instance.
*
*
* @return Defines the cost per hour for the instance.
*/
public Float getCostPerHour() {
return this.costPerHour;
}
/**
*
* Defines the cost per hour for the instance.
*
*
* @param costPerHour
* Defines the cost per hour for the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withCostPerHour(Float costPerHour) {
setCostPerHour(costPerHour);
return this;
}
/**
*
* Defines the cost per inference for the instance .
*
*
* @param costPerInference
* Defines the cost per inference for the instance .
*/
public void setCostPerInference(Float costPerInference) {
this.costPerInference = costPerInference;
}
/**
*
* Defines the cost per inference for the instance .
*
*
* @return Defines the cost per inference for the instance .
*/
public Float getCostPerInference() {
return this.costPerInference;
}
/**
*
* Defines the cost per inference for the instance .
*
*
* @param costPerInference
* Defines the cost per inference for the instance .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withCostPerInference(Float costPerInference) {
setCostPerInference(costPerInference);
return this;
}
/**
*
* The expected maximum number of requests per minute for the instance.
*
*
* @param maxInvocations
* The expected maximum number of requests per minute for the instance.
*/
public void setMaxInvocations(Integer maxInvocations) {
this.maxInvocations = maxInvocations;
}
/**
*
* The expected maximum number of requests per minute for the instance.
*
*
* @return The expected maximum number of requests per minute for the instance.
*/
public Integer getMaxInvocations() {
return this.maxInvocations;
}
/**
*
* The expected maximum number of requests per minute for the instance.
*
*
* @param maxInvocations
* The expected maximum number of requests per minute for the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withMaxInvocations(Integer maxInvocations) {
setMaxInvocations(maxInvocations);
return this;
}
/**
*
* The expected model latency at maximum invocation per minute for the instance.
*
*
* @param modelLatency
* The expected model latency at maximum invocation per minute for the instance.
*/
public void setModelLatency(Integer modelLatency) {
this.modelLatency = modelLatency;
}
/**
*
* The expected model latency at maximum invocation per minute for the instance.
*
*
* @return The expected model latency at maximum invocation per minute for the instance.
*/
public Integer getModelLatency() {
return this.modelLatency;
}
/**
*
* The expected model latency at maximum invocation per minute for the instance.
*
*
* @param modelLatency
* The expected model latency at maximum invocation per minute for the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withModelLatency(Integer modelLatency) {
setModelLatency(modelLatency);
return this;
}
/**
*
* The expected CPU utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*
* @param cpuUtilization
* The expected CPU utilization at maximum invocations per minute for the instance.
*
* NaN indicates that the value is not available.
*/
public void setCpuUtilization(Float cpuUtilization) {
this.cpuUtilization = cpuUtilization;
}
/**
*
* The expected CPU utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*
* @return The expected CPU utilization at maximum invocations per minute for the instance.
*
* NaN indicates that the value is not available.
*/
public Float getCpuUtilization() {
return this.cpuUtilization;
}
/**
*
* The expected CPU utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*
* @param cpuUtilization
* The expected CPU utilization at maximum invocations per minute for the instance.
*
* NaN indicates that the value is not available.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withCpuUtilization(Float cpuUtilization) {
setCpuUtilization(cpuUtilization);
return this;
}
/**
*
* The expected memory utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*
* @param memoryUtilization
* The expected memory utilization at maximum invocations per minute for the instance.
*
* NaN indicates that the value is not available.
*/
public void setMemoryUtilization(Float memoryUtilization) {
this.memoryUtilization = memoryUtilization;
}
/**
*
* The expected memory utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*
* @return The expected memory utilization at maximum invocations per minute for the instance.
*
* NaN indicates that the value is not available.
*/
public Float getMemoryUtilization() {
return this.memoryUtilization;
}
/**
*
* The expected memory utilization at maximum invocations per minute for the instance.
*
*
* NaN indicates that the value is not available.
*
*
* @param memoryUtilization
* The expected memory utilization at maximum invocations per minute for the instance.
*
* NaN indicates that the value is not available.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withMemoryUtilization(Float memoryUtilization) {
setMemoryUtilization(memoryUtilization);
return this;
}
/**
*
* The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the
* model size, how long it takes to download the model, and the start-up time of the container.
*
*
* NaN indicates that the value is not available.
*
*
* @param modelSetupTime
* The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending
* on the model size, how long it takes to download the model, and the start-up time of the container.
*
* NaN indicates that the value is not available.
*/
public void setModelSetupTime(Integer modelSetupTime) {
this.modelSetupTime = modelSetupTime;
}
/**
*
* The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the
* model size, how long it takes to download the model, and the start-up time of the container.
*
*
* NaN indicates that the value is not available.
*
*
* @return The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending
* on the model size, how long it takes to download the model, and the start-up time of the container.
*
* NaN indicates that the value is not available.
*/
public Integer getModelSetupTime() {
return this.modelSetupTime;
}
/**
*
* The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the
* model size, how long it takes to download the model, and the start-up time of the container.
*
*
* NaN indicates that the value is not available.
*
*
* @param modelSetupTime
* The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending
* on the model size, how long it takes to download the model, and the start-up time of the container.
*
* NaN indicates that the value is not available.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RecommendationMetrics withModelSetupTime(Integer modelSetupTime) {
setModelSetupTime(modelSetupTime);
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 (getCostPerHour() != null)
sb.append("CostPerHour: ").append(getCostPerHour()).append(",");
if (getCostPerInference() != null)
sb.append("CostPerInference: ").append(getCostPerInference()).append(",");
if (getMaxInvocations() != null)
sb.append("MaxInvocations: ").append(getMaxInvocations()).append(",");
if (getModelLatency() != null)
sb.append("ModelLatency: ").append(getModelLatency()).append(",");
if (getCpuUtilization() != null)
sb.append("CpuUtilization: ").append(getCpuUtilization()).append(",");
if (getMemoryUtilization() != null)
sb.append("MemoryUtilization: ").append(getMemoryUtilization()).append(",");
if (getModelSetupTime() != null)
sb.append("ModelSetupTime: ").append(getModelSetupTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RecommendationMetrics == false)
return false;
RecommendationMetrics other = (RecommendationMetrics) obj;
if (other.getCostPerHour() == null ^ this.getCostPerHour() == null)
return false;
if (other.getCostPerHour() != null && other.getCostPerHour().equals(this.getCostPerHour()) == false)
return false;
if (other.getCostPerInference() == null ^ this.getCostPerInference() == null)
return false;
if (other.getCostPerInference() != null && other.getCostPerInference().equals(this.getCostPerInference()) == false)
return false;
if (other.getMaxInvocations() == null ^ this.getMaxInvocations() == null)
return false;
if (other.getMaxInvocations() != null && other.getMaxInvocations().equals(this.getMaxInvocations()) == false)
return false;
if (other.getModelLatency() == null ^ this.getModelLatency() == null)
return false;
if (other.getModelLatency() != null && other.getModelLatency().equals(this.getModelLatency()) == false)
return false;
if (other.getCpuUtilization() == null ^ this.getCpuUtilization() == null)
return false;
if (other.getCpuUtilization() != null && other.getCpuUtilization().equals(this.getCpuUtilization()) == false)
return false;
if (other.getMemoryUtilization() == null ^ this.getMemoryUtilization() == null)
return false;
if (other.getMemoryUtilization() != null && other.getMemoryUtilization().equals(this.getMemoryUtilization()) == false)
return false;
if (other.getModelSetupTime() == null ^ this.getModelSetupTime() == null)
return false;
if (other.getModelSetupTime() != null && other.getModelSetupTime().equals(this.getModelSetupTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCostPerHour() == null) ? 0 : getCostPerHour().hashCode());
hashCode = prime * hashCode + ((getCostPerInference() == null) ? 0 : getCostPerInference().hashCode());
hashCode = prime * hashCode + ((getMaxInvocations() == null) ? 0 : getMaxInvocations().hashCode());
hashCode = prime * hashCode + ((getModelLatency() == null) ? 0 : getModelLatency().hashCode());
hashCode = prime * hashCode + ((getCpuUtilization() == null) ? 0 : getCpuUtilization().hashCode());
hashCode = prime * hashCode + ((getMemoryUtilization() == null) ? 0 : getMemoryUtilization().hashCode());
hashCode = prime * hashCode + ((getModelSetupTime() == null) ? 0 : getModelSetupTime().hashCode());
return hashCode;
}
@Override
public RecommendationMetrics clone() {
try {
return (RecommendationMetrics) 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.sagemaker.model.transform.RecommendationMetricsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}