software.amazon.awssdk.services.forecast.model.MetricResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of forecast Show documentation
Show all versions of forecast Show documentation
The AWS Java SDK for Forecast module holds the client classes that are used for
communicating with Forecast.
The newest version!
/*
* Copyright 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 software.amazon.awssdk.services.forecast.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric
* to the metric's value in the Baseline to see how your predictor's performance is changing.
*
*
* For more information about metrics generated by Forecast see Evaluating Predictor Accuracy
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricResult implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MetricName").getter(getter(MetricResult::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricName").build()).build();
private static final SdkField METRIC_VALUE_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("MetricValue").getter(getter(MetricResult::metricValue)).setter(setter(Builder::metricValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricValue").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METRIC_NAME_FIELD,
METRIC_VALUE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("MetricName", METRIC_NAME_FIELD);
put("MetricValue", METRIC_VALUE_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String metricName;
private final Double metricValue;
private MetricResult(BuilderImpl builder) {
this.metricName = builder.metricName;
this.metricValue = builder.metricValue;
}
/**
*
* The name of the metric.
*
*
* @return The name of the metric.
*/
public final String metricName() {
return metricName;
}
/**
*
* The value for the metric.
*
*
* @return The value for the metric.
*/
public final Double metricValue() {
return metricValue;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(metricValue());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MetricResult)) {
return false;
}
MetricResult other = (MetricResult) obj;
return Objects.equals(metricName(), other.metricName()) && Objects.equals(metricValue(), other.metricValue());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("MetricResult").add("MetricName", metricName()).add("MetricValue", metricValue()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MetricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "MetricValue":
return Optional.ofNullable(clazz.cast(metricValue()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((MetricResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the metric.
*
*
* @param metricName
* The name of the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* The value for the metric.
*
*
* @param metricValue
* The value for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricValue(Double metricValue);
}
static final class BuilderImpl implements Builder {
private String metricName;
private Double metricValue;
private BuilderImpl() {
}
private BuilderImpl(MetricResult model) {
metricName(model.metricName);
metricValue(model.metricValue);
}
public final String getMetricName() {
return metricName;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final Double getMetricValue() {
return metricValue;
}
public final void setMetricValue(Double metricValue) {
this.metricValue = metricValue;
}
@Override
public final Builder metricValue(Double metricValue) {
this.metricValue = metricValue;
return this;
}
@Override
public MetricResult build() {
return new MetricResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}