software.amazon.awssdk.services.sagemaker.model.AutoMLContainerDefinition Maven / Gradle / Ivy
/*
* 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.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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A list of container definitions that describe the different containers that make up an AutoML candidate. For more
* information, see .
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AutoMLContainerDefinition implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField IMAGE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Image")
.getter(getter(AutoMLContainerDefinition::image)).setter(setter(Builder::image))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Image").build()).build();
private static final SdkField MODEL_DATA_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelDataUrl").getter(getter(AutoMLContainerDefinition::modelDataUrl))
.setter(setter(Builder::modelDataUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelDataUrl").build()).build();
private static final SdkField> ENVIRONMENT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Environment")
.getter(getter(AutoMLContainerDefinition::environment))
.setter(setter(Builder::environment))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Environment").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(IMAGE_FIELD,
MODEL_DATA_URL_FIELD, ENVIRONMENT_FIELD));
private static final long serialVersionUID = 1L;
private final String image;
private final String modelDataUrl;
private final Map environment;
private AutoMLContainerDefinition(BuilderImpl builder) {
this.image = builder.image;
this.modelDataUrl = builder.modelDataUrl;
this.environment = builder.environment;
}
/**
*
* The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .
*
*
* @return The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .
*/
public final String image() {
return image;
}
/**
*
* The location of the model artifacts. For more information, see .
*
*
* @return The location of the model artifacts. For more information, see .
*/
public final String modelDataUrl() {
return modelDataUrl;
}
/**
* For responses, this returns true if the service returned a value for the Environment 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 hasEnvironment() {
return environment != null && !(environment instanceof SdkAutoConstructMap);
}
/**
*
* The environment variables to set in the container. For more information, see .
*
*
* 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 #hasEnvironment} method.
*
*
* @return The environment variables to set in the container. For more information, see .
*/
public final Map environment() {
return environment;
}
@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(image());
hashCode = 31 * hashCode + Objects.hashCode(modelDataUrl());
hashCode = 31 * hashCode + Objects.hashCode(hasEnvironment() ? environment() : 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 AutoMLContainerDefinition)) {
return false;
}
AutoMLContainerDefinition other = (AutoMLContainerDefinition) obj;
return Objects.equals(image(), other.image()) && Objects.equals(modelDataUrl(), other.modelDataUrl())
&& hasEnvironment() == other.hasEnvironment() && Objects.equals(environment(), other.environment());
}
/**
* 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("AutoMLContainerDefinition").add("Image", image()).add("ModelDataUrl", modelDataUrl())
.add("Environment", hasEnvironment() ? environment() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Image":
return Optional.ofNullable(clazz.cast(image()));
case "ModelDataUrl":
return Optional.ofNullable(clazz.cast(modelDataUrl()));
case "Environment":
return Optional.ofNullable(clazz.cast(environment()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AutoMLContainerDefinition) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .
*
*
* @param image
* The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder image(String image);
/**
*
* The location of the model artifacts. For more information, see .
*
*
* @param modelDataUrl
* The location of the model artifacts. For more information, see .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelDataUrl(String modelDataUrl);
/**
*
* The environment variables to set in the container. For more information, see .
*
*
* @param environment
* The environment variables to set in the container. For more information, see .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environment(Map environment);
}
static final class BuilderImpl implements Builder {
private String image;
private String modelDataUrl;
private Map environment = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AutoMLContainerDefinition model) {
image(model.image);
modelDataUrl(model.modelDataUrl);
environment(model.environment);
}
public final String getImage() {
return image;
}
public final void setImage(String image) {
this.image = image;
}
@Override
public final Builder image(String image) {
this.image = image;
return this;
}
public final String getModelDataUrl() {
return modelDataUrl;
}
public final void setModelDataUrl(String modelDataUrl) {
this.modelDataUrl = modelDataUrl;
}
@Override
public final Builder modelDataUrl(String modelDataUrl) {
this.modelDataUrl = modelDataUrl;
return this;
}
public final Map getEnvironment() {
if (environment instanceof SdkAutoConstructMap) {
return null;
}
return environment;
}
public final void setEnvironment(Map environment) {
this.environment = EnvironmentMapCopier.copy(environment);
}
@Override
public final Builder environment(Map environment) {
this.environment = EnvironmentMapCopier.copy(environment);
return this;
}
@Override
public AutoMLContainerDefinition build() {
return new AutoMLContainerDefinition(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy