software.amazon.awssdk.services.sagemaker.model.ModelExplainabilityAppSpecification 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.HashMap;
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;
/**
*
* Docker container image configuration object for the model explainability job.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModelExplainabilityAppSpecification implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField IMAGE_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageUri").getter(getter(ModelExplainabilityAppSpecification::imageUri))
.setter(setter(Builder::imageUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageUri").build()).build();
private static final SdkField CONFIG_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConfigUri").getter(getter(ModelExplainabilityAppSpecification::configUri))
.setter(setter(Builder::configUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigUri").build()).build();
private static final SdkField> ENVIRONMENT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Environment")
.getter(getter(ModelExplainabilityAppSpecification::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_URI_FIELD,
CONFIG_URI_FIELD, ENVIRONMENT_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String imageUri;
private final String configUri;
private final Map environment;
private ModelExplainabilityAppSpecification(BuilderImpl builder) {
this.imageUri = builder.imageUri;
this.configUri = builder.configUri;
this.environment = builder.environment;
}
/**
*
* The container image to be run by the model explainability job.
*
*
* @return The container image to be run by the model explainability job.
*/
public final String imageUri() {
return imageUri;
}
/**
*
* JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
* configuration file, see Configure model explainability parameters.
*
*
* @return JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
* configuration file, see Configure model explainability parameters.
*/
public final String configUri() {
return configUri;
}
/**
* 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);
}
/**
*
* Sets the environment variables in the Docker container.
*
*
* 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 Sets the environment variables in the Docker container.
*/
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(imageUri());
hashCode = 31 * hashCode + Objects.hashCode(configUri());
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 ModelExplainabilityAppSpecification)) {
return false;
}
ModelExplainabilityAppSpecification other = (ModelExplainabilityAppSpecification) obj;
return Objects.equals(imageUri(), other.imageUri()) && Objects.equals(configUri(), other.configUri())
&& 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("ModelExplainabilityAppSpecification").add("ImageUri", imageUri()).add("ConfigUri", configUri())
.add("Environment", hasEnvironment() ? environment() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ImageUri":
return Optional.ofNullable(clazz.cast(imageUri()));
case "ConfigUri":
return Optional.ofNullable(clazz.cast(configUri()));
case "Environment":
return Optional.ofNullable(clazz.cast(environment()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("ImageUri", IMAGE_URI_FIELD);
map.put("ConfigUri", CONFIG_URI_FIELD);
map.put("Environment", ENVIRONMENT_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ModelExplainabilityAppSpecification) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The container image to be run by the model explainability job.
*
*
* @param imageUri
* The container image to be run by the model explainability job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageUri(String imageUri);
/**
*
* JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
* configuration file, see Configure model explainability parameters.
*
*
* @param configUri
* JSON formatted Amazon S3 file that defines explainability parameters. For more information on this
* JSON configuration file, see Configure model explainability parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configUri(String configUri);
/**
*
* Sets the environment variables in the Docker container.
*
*
* @param environment
* Sets the environment variables in the Docker container.
* @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 imageUri;
private String configUri;
private Map environment = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ModelExplainabilityAppSpecification model) {
imageUri(model.imageUri);
configUri(model.configUri);
environment(model.environment);
}
public final String getImageUri() {
return imageUri;
}
public final void setImageUri(String imageUri) {
this.imageUri = imageUri;
}
@Override
public final Builder imageUri(String imageUri) {
this.imageUri = imageUri;
return this;
}
public final String getConfigUri() {
return configUri;
}
public final void setConfigUri(String configUri) {
this.configUri = configUri;
}
@Override
public final Builder configUri(String configUri) {
this.configUri = configUri;
return this;
}
public final Map getEnvironment() {
if (environment instanceof SdkAutoConstructMap) {
return null;
}
return environment;
}
public final void setEnvironment(Map environment) {
this.environment = MonitoringEnvironmentMapCopier.copy(environment);
}
@Override
public final Builder environment(Map environment) {
this.environment = MonitoringEnvironmentMapCopier.copy(environment);
return this;
}
@Override
public ModelExplainabilityAppSpecification build() {
return new ModelExplainabilityAppSpecification(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy