software.amazon.awssdk.services.sagemaker.model.ResourceLimits Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker Service
/*
* 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.sagemaker.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 the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResourceLimits implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField MAX_NUMBER_OF_TRAINING_JOBS_FIELD = SdkField
. builder(MarshallingType.INTEGER).memberName("MaxNumberOfTrainingJobs")
.getter(getter(ResourceLimits::maxNumberOfTrainingJobs)).setter(setter(Builder::maxNumberOfTrainingJobs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxNumberOfTrainingJobs").build())
.build();
private static final SdkField MAX_PARALLEL_TRAINING_JOBS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxParallelTrainingJobs").getter(getter(ResourceLimits::maxParallelTrainingJobs))
.setter(setter(Builder::maxParallelTrainingJobs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxParallelTrainingJobs").build())
.build();
private static final SdkField MAX_RUNTIME_IN_SECONDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRuntimeInSeconds").getter(getter(ResourceLimits::maxRuntimeInSeconds))
.setter(setter(Builder::maxRuntimeInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRuntimeInSeconds").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
MAX_NUMBER_OF_TRAINING_JOBS_FIELD, MAX_PARALLEL_TRAINING_JOBS_FIELD, MAX_RUNTIME_IN_SECONDS_FIELD));
private static final long serialVersionUID = 1L;
private final Integer maxNumberOfTrainingJobs;
private final Integer maxParallelTrainingJobs;
private final Integer maxRuntimeInSeconds;
private ResourceLimits(BuilderImpl builder) {
this.maxNumberOfTrainingJobs = builder.maxNumberOfTrainingJobs;
this.maxParallelTrainingJobs = builder.maxParallelTrainingJobs;
this.maxRuntimeInSeconds = builder.maxRuntimeInSeconds;
}
/**
*
* The maximum number of training jobs that a hyperparameter tuning job can launch.
*
*
* @return The maximum number of training jobs that a hyperparameter tuning job can launch.
*/
public final Integer maxNumberOfTrainingJobs() {
return maxNumberOfTrainingJobs;
}
/**
*
* The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
*
*
* @return The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
*/
public final Integer maxParallelTrainingJobs() {
return maxParallelTrainingJobs;
}
/**
*
* The maximum time in seconds that a hyperparameter tuning job can run.
*
*
* @return The maximum time in seconds that a hyperparameter tuning job can run.
*/
public final Integer maxRuntimeInSeconds() {
return maxRuntimeInSeconds;
}
@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(maxNumberOfTrainingJobs());
hashCode = 31 * hashCode + Objects.hashCode(maxParallelTrainingJobs());
hashCode = 31 * hashCode + Objects.hashCode(maxRuntimeInSeconds());
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 ResourceLimits)) {
return false;
}
ResourceLimits other = (ResourceLimits) obj;
return Objects.equals(maxNumberOfTrainingJobs(), other.maxNumberOfTrainingJobs())
&& Objects.equals(maxParallelTrainingJobs(), other.maxParallelTrainingJobs())
&& Objects.equals(maxRuntimeInSeconds(), other.maxRuntimeInSeconds());
}
/**
* 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("ResourceLimits").add("MaxNumberOfTrainingJobs", maxNumberOfTrainingJobs())
.add("MaxParallelTrainingJobs", maxParallelTrainingJobs()).add("MaxRuntimeInSeconds", maxRuntimeInSeconds())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MaxNumberOfTrainingJobs":
return Optional.ofNullable(clazz.cast(maxNumberOfTrainingJobs()));
case "MaxParallelTrainingJobs":
return Optional.ofNullable(clazz.cast(maxParallelTrainingJobs()));
case "MaxRuntimeInSeconds":
return Optional.ofNullable(clazz.cast(maxRuntimeInSeconds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResourceLimits) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The maximum number of training jobs that a hyperparameter tuning job can launch.
*
*
* @param maxNumberOfTrainingJobs
* The maximum number of training jobs that a hyperparameter tuning job can launch.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxNumberOfTrainingJobs(Integer maxNumberOfTrainingJobs);
/**
*
* The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
*
*
* @param maxParallelTrainingJobs
* The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxParallelTrainingJobs(Integer maxParallelTrainingJobs);
/**
*
* The maximum time in seconds that a hyperparameter tuning job can run.
*
*
* @param maxRuntimeInSeconds
* The maximum time in seconds that a hyperparameter tuning job can run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRuntimeInSeconds(Integer maxRuntimeInSeconds);
}
static final class BuilderImpl implements Builder {
private Integer maxNumberOfTrainingJobs;
private Integer maxParallelTrainingJobs;
private Integer maxRuntimeInSeconds;
private BuilderImpl() {
}
private BuilderImpl(ResourceLimits model) {
maxNumberOfTrainingJobs(model.maxNumberOfTrainingJobs);
maxParallelTrainingJobs(model.maxParallelTrainingJobs);
maxRuntimeInSeconds(model.maxRuntimeInSeconds);
}
public final Integer getMaxNumberOfTrainingJobs() {
return maxNumberOfTrainingJobs;
}
public final void setMaxNumberOfTrainingJobs(Integer maxNumberOfTrainingJobs) {
this.maxNumberOfTrainingJobs = maxNumberOfTrainingJobs;
}
@Override
public final Builder maxNumberOfTrainingJobs(Integer maxNumberOfTrainingJobs) {
this.maxNumberOfTrainingJobs = maxNumberOfTrainingJobs;
return this;
}
public final Integer getMaxParallelTrainingJobs() {
return maxParallelTrainingJobs;
}
public final void setMaxParallelTrainingJobs(Integer maxParallelTrainingJobs) {
this.maxParallelTrainingJobs = maxParallelTrainingJobs;
}
@Override
public final Builder maxParallelTrainingJobs(Integer maxParallelTrainingJobs) {
this.maxParallelTrainingJobs = maxParallelTrainingJobs;
return this;
}
public final Integer getMaxRuntimeInSeconds() {
return maxRuntimeInSeconds;
}
public final void setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds) {
this.maxRuntimeInSeconds = maxRuntimeInSeconds;
}
@Override
public final Builder maxRuntimeInSeconds(Integer maxRuntimeInSeconds) {
this.maxRuntimeInSeconds = maxRuntimeInSeconds;
return this;
}
@Override
public ResourceLimits build() {
return new ResourceLimits(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}