software.amazon.awssdk.services.forecast.model.EvaluationResult Maven / Gradle / Ivy
Show all versions of forecast Show documentation
/*
* 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.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EvaluationResult implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ALGORITHM_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AlgorithmArn").getter(getter(EvaluationResult::algorithmArn)).setter(setter(Builder::algorithmArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AlgorithmArn").build()).build();
private static final SdkField> TEST_WINDOWS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TestWindows")
.getter(getter(EvaluationResult::testWindows))
.setter(setter(Builder::testWindows))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TestWindows").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(WindowSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALGORITHM_ARN_FIELD,
TEST_WINDOWS_FIELD));
private static final long serialVersionUID = 1L;
private final String algorithmArn;
private final List testWindows;
private EvaluationResult(BuilderImpl builder) {
this.algorithmArn = builder.algorithmArn;
this.testWindows = builder.testWindows;
}
/**
*
* The Amazon Resource Name (ARN) of the algorithm that was evaluated.
*
*
* @return The Amazon Resource Name (ARN) of the algorithm that was evaluated.
*/
public final String algorithmArn() {
return algorithmArn;
}
/**
* For responses, this returns true if the service returned a value for the TestWindows property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasTestWindows() {
return testWindows != null && !(testWindows instanceof SdkAutoConstructList);
}
/**
*
* The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the
* EvaluationParameters object determines the number of windows in the array.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTestWindows} method.
*
*
* @return The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows
* from the EvaluationParameters object determines the number of windows in the array.
*/
public final List testWindows() {
return testWindows;
}
@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(algorithmArn());
hashCode = 31 * hashCode + Objects.hashCode(hasTestWindows() ? testWindows() : null);
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 EvaluationResult)) {
return false;
}
EvaluationResult other = (EvaluationResult) obj;
return Objects.equals(algorithmArn(), other.algorithmArn()) && hasTestWindows() == other.hasTestWindows()
&& Objects.equals(testWindows(), other.testWindows());
}
/**
* 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("EvaluationResult").add("AlgorithmArn", algorithmArn())
.add("TestWindows", hasTestWindows() ? testWindows() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AlgorithmArn":
return Optional.ofNullable(clazz.cast(algorithmArn()));
case "TestWindows":
return Optional.ofNullable(clazz.cast(testWindows()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EvaluationResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the algorithm that was evaluated.
*
*
* @param algorithmArn
* The Amazon Resource Name (ARN) of the algorithm that was evaluated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder algorithmArn(String algorithmArn);
/**
*
* The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from
* the EvaluationParameters object determines the number of windows in the array.
*
*
* @param testWindows
* The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows
* from the EvaluationParameters object determines the number of windows in the array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder testWindows(Collection testWindows);
/**
*
* The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from
* the EvaluationParameters object determines the number of windows in the array.
*
*
* @param testWindows
* The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows
* from the EvaluationParameters object determines the number of windows in the array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder testWindows(WindowSummary... testWindows);
/**
*
* The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from
* the EvaluationParameters object determines the number of windows in the array.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.forecast.model.WindowSummary.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.forecast.model.WindowSummary#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.forecast.model.WindowSummary.Builder#build()} is called immediately
* and its result is passed to {@link #testWindows(List)}.
*
* @param testWindows
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.forecast.model.WindowSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #testWindows(java.util.Collection)
*/
Builder testWindows(Consumer... testWindows);
}
static final class BuilderImpl implements Builder {
private String algorithmArn;
private List testWindows = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(EvaluationResult model) {
algorithmArn(model.algorithmArn);
testWindows(model.testWindows);
}
public final String getAlgorithmArn() {
return algorithmArn;
}
public final void setAlgorithmArn(String algorithmArn) {
this.algorithmArn = algorithmArn;
}
@Override
public final Builder algorithmArn(String algorithmArn) {
this.algorithmArn = algorithmArn;
return this;
}
public final List getTestWindows() {
List result = TestWindowsCopier.copyToBuilder(this.testWindows);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTestWindows(Collection testWindows) {
this.testWindows = TestWindowsCopier.copyFromBuilder(testWindows);
}
@Override
public final Builder testWindows(Collection testWindows) {
this.testWindows = TestWindowsCopier.copy(testWindows);
return this;
}
@Override
@SafeVarargs
public final Builder testWindows(WindowSummary... testWindows) {
testWindows(Arrays.asList(testWindows));
return this;
}
@Override
@SafeVarargs
public final Builder testWindows(Consumer... testWindows) {
testWindows(Stream.of(testWindows).map(c -> WindowSummary.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public EvaluationResult build() {
return new EvaluationResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}