software.amazon.awssdk.services.forecast.model.IntegerParameterRange 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.Collections;
import java.util.List;
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;
/**
*
* Specifies an integer hyperparameter and it's range of tunable values. This object is part of the
* ParameterRanges object.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class IntegerParameterRange implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(IntegerParameterRange::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField MAX_VALUE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxValue").getter(getter(IntegerParameterRange::maxValue)).setter(setter(Builder::maxValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxValue").build()).build();
private static final SdkField MIN_VALUE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MinValue").getter(getter(IntegerParameterRange::minValue)).setter(setter(Builder::minValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MinValue").build()).build();
private static final SdkField SCALING_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ScalingType").getter(getter(IntegerParameterRange::scalingTypeAsString))
.setter(setter(Builder::scalingType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScalingType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, MAX_VALUE_FIELD,
MIN_VALUE_FIELD, SCALING_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final Integer maxValue;
private final Integer minValue;
private final String scalingType;
private IntegerParameterRange(BuilderImpl builder) {
this.name = builder.name;
this.maxValue = builder.maxValue;
this.minValue = builder.minValue;
this.scalingType = builder.scalingType;
}
/**
*
* The name of the hyperparameter to tune.
*
*
* @return The name of the hyperparameter to tune.
*/
public final String name() {
return name;
}
/**
*
* The maximum tunable value of the hyperparameter.
*
*
* @return The maximum tunable value of the hyperparameter.
*/
public final Integer maxValue() {
return maxValue;
}
/**
*
* The minimum tunable value of the hyperparameter.
*
*
* @return The minimum tunable value of the hyperparameter.
*/
public final Integer minValue() {
return minValue;
}
/**
*
* The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scalingType} will
* return {@link ScalingType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scalingTypeAsString}.
*
*
* @return The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
* @see ScalingType
*/
public final ScalingType scalingType() {
return ScalingType.fromValue(scalingType);
}
/**
*
* The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scalingType} will
* return {@link ScalingType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scalingTypeAsString}.
*
*
* @return The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
* @see ScalingType
*/
public final String scalingTypeAsString() {
return scalingType;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(maxValue());
hashCode = 31 * hashCode + Objects.hashCode(minValue());
hashCode = 31 * hashCode + Objects.hashCode(scalingTypeAsString());
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 IntegerParameterRange)) {
return false;
}
IntegerParameterRange other = (IntegerParameterRange) obj;
return Objects.equals(name(), other.name()) && Objects.equals(maxValue(), other.maxValue())
&& Objects.equals(minValue(), other.minValue())
&& Objects.equals(scalingTypeAsString(), other.scalingTypeAsString());
}
/**
* 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("IntegerParameterRange").add("Name", name()).add("MaxValue", maxValue())
.add("MinValue", minValue()).add("ScalingType", scalingTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "MaxValue":
return Optional.ofNullable(clazz.cast(maxValue()));
case "MinValue":
return Optional.ofNullable(clazz.cast(minValue()));
case "ScalingType":
return Optional.ofNullable(clazz.cast(scalingTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((IntegerParameterRange) 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 hyperparameter to tune.
*
*
* @param name
* The name of the hyperparameter to tune.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The maximum tunable value of the hyperparameter.
*
*
* @param maxValue
* The maximum tunable value of the hyperparameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxValue(Integer maxValue);
/**
*
* The minimum tunable value of the hyperparameter.
*
*
* @param minValue
* The minimum tunable value of the hyperparameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder minValue(Integer minValue);
/**
*
* The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
*
*
* @param scalingType
* The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x <
* 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
* @see ScalingType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalingType
*/
Builder scalingType(String scalingType);
/**
*
* The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
*
*
* @param scalingType
* The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
*
* - Auto
* -
*
* Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
*
*
* - Linear
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
*
*
* - Logarithmic
* -
*
* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
*
*
* Logarithmic scaling works only for ranges that have values greater than 0.
*
*
* - ReverseLogarithmic
* -
*
* Not supported for IntegerParameterRange.
*
*
* Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x <
* 1.0.
*
*
*
*
* For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
* @see ScalingType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalingType
*/
Builder scalingType(ScalingType scalingType);
}
static final class BuilderImpl implements Builder {
private String name;
private Integer maxValue;
private Integer minValue;
private String scalingType;
private BuilderImpl() {
}
private BuilderImpl(IntegerParameterRange model) {
name(model.name);
maxValue(model.maxValue);
minValue(model.minValue);
scalingType(model.scalingType);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Integer getMaxValue() {
return maxValue;
}
public final void setMaxValue(Integer maxValue) {
this.maxValue = maxValue;
}
@Override
public final Builder maxValue(Integer maxValue) {
this.maxValue = maxValue;
return this;
}
public final Integer getMinValue() {
return minValue;
}
public final void setMinValue(Integer minValue) {
this.minValue = minValue;
}
@Override
public final Builder minValue(Integer minValue) {
this.minValue = minValue;
return this;
}
public final String getScalingType() {
return scalingType;
}
public final void setScalingType(String scalingType) {
this.scalingType = scalingType;
}
@Override
public final Builder scalingType(String scalingType) {
this.scalingType = scalingType;
return this;
}
@Override
public final Builder scalingType(ScalingType scalingType) {
this.scalingType(scalingType == null ? null : scalingType.toString());
return this;
}
@Override
public IntegerParameterRange build() {
return new IntegerParameterRange(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}