software.amazon.awssdk.services.sagemaker.model.ModelConfiguration 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.beans.Transient;
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;
/**
*
* Defines the model configuration. Includes the specification name and environment parameters.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModelConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField INFERENCE_SPECIFICATION_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("InferenceSpecificationName")
.getter(getter(ModelConfiguration::inferenceSpecificationName))
.setter(setter(Builder::inferenceSpecificationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InferenceSpecificationName").build())
.build();
private static final SdkField> ENVIRONMENT_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EnvironmentParameters")
.getter(getter(ModelConfiguration::environmentParameters))
.setter(setter(Builder::environmentParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentParameters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EnvironmentParameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
INFERENCE_SPECIFICATION_NAME_FIELD, ENVIRONMENT_PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final String inferenceSpecificationName;
private final List environmentParameters;
private ModelConfiguration(BuilderImpl builder) {
this.inferenceSpecificationName = builder.inferenceSpecificationName;
this.environmentParameters = builder.environmentParameters;
}
/**
*
* The inference specification name in the model package version.
*
*
* @return The inference specification name in the model package version.
*/
public final String inferenceSpecificationName() {
return inferenceSpecificationName;
}
/**
* For responses, this returns true if the service returned a value for the EnvironmentParameters 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 hasEnvironmentParameters() {
return environmentParameters != null && !(environmentParameters instanceof SdkAutoConstructList);
}
/**
*
* Defines the environment parameters that includes key, value types, and values.
*
*
* 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 #hasEnvironmentParameters} method.
*
*
* @return Defines the environment parameters that includes key, value types, and values.
*/
public final List environmentParameters() {
return environmentParameters;
}
@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(inferenceSpecificationName());
hashCode = 31 * hashCode + Objects.hashCode(hasEnvironmentParameters() ? environmentParameters() : 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 ModelConfiguration)) {
return false;
}
ModelConfiguration other = (ModelConfiguration) obj;
return Objects.equals(inferenceSpecificationName(), other.inferenceSpecificationName())
&& hasEnvironmentParameters() == other.hasEnvironmentParameters()
&& Objects.equals(environmentParameters(), other.environmentParameters());
}
/**
* 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("ModelConfiguration").add("InferenceSpecificationName", inferenceSpecificationName())
.add("EnvironmentParameters", hasEnvironmentParameters() ? environmentParameters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InferenceSpecificationName":
return Optional.ofNullable(clazz.cast(inferenceSpecificationName()));
case "EnvironmentParameters":
return Optional.ofNullable(clazz.cast(environmentParameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModelConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The inference specification name in the model package version.
*
*
* @param inferenceSpecificationName
* The inference specification name in the model package version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inferenceSpecificationName(String inferenceSpecificationName);
/**
*
* Defines the environment parameters that includes key, value types, and values.
*
*
* @param environmentParameters
* Defines the environment parameters that includes key, value types, and values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentParameters(Collection environmentParameters);
/**
*
* Defines the environment parameters that includes key, value types, and values.
*
*
* @param environmentParameters
* Defines the environment parameters that includes key, value types, and values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentParameters(EnvironmentParameter... environmentParameters);
/**
*
* Defines the environment parameters that includes key, value types, and values.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #environmentParameters(List)}.
*
* @param environmentParameters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #environmentParameters(List)
*/
Builder environmentParameters(Consumer... environmentParameters);
}
static final class BuilderImpl implements Builder {
private String inferenceSpecificationName;
private List environmentParameters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ModelConfiguration model) {
inferenceSpecificationName(model.inferenceSpecificationName);
environmentParameters(model.environmentParameters);
}
public final String getInferenceSpecificationName() {
return inferenceSpecificationName;
}
public final void setInferenceSpecificationName(String inferenceSpecificationName) {
this.inferenceSpecificationName = inferenceSpecificationName;
}
@Override
@Transient
public final Builder inferenceSpecificationName(String inferenceSpecificationName) {
this.inferenceSpecificationName = inferenceSpecificationName;
return this;
}
public final List getEnvironmentParameters() {
List result = EnvironmentParametersCopier.copyToBuilder(this.environmentParameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEnvironmentParameters(Collection environmentParameters) {
this.environmentParameters = EnvironmentParametersCopier.copyFromBuilder(environmentParameters);
}
@Override
@Transient
public final Builder environmentParameters(Collection environmentParameters) {
this.environmentParameters = EnvironmentParametersCopier.copy(environmentParameters);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder environmentParameters(EnvironmentParameter... environmentParameters) {
environmentParameters(Arrays.asList(environmentParameters));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder environmentParameters(Consumer... environmentParameters) {
environmentParameters(Stream.of(environmentParameters)
.map(c -> EnvironmentParameter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ModelConfiguration build() {
return new ModelConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy