software.amazon.awssdk.services.sagemaker.model.ModelVariantConfigSummary Maven / Gradle / Ivy
Show all versions of sagemaker 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.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.Consumer;
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;
/**
*
* Summary of the deployment configuration of a model.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModelVariantConfigSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MODEL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelName").getter(getter(ModelVariantConfigSummary::modelName)).setter(setter(Builder::modelName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelName").build()).build();
private static final SdkField VARIANT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VariantName").getter(getter(ModelVariantConfigSummary::variantName))
.setter(setter(Builder::variantName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VariantName").build()).build();
private static final SdkField INFRASTRUCTURE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("InfrastructureConfig")
.getter(getter(ModelVariantConfigSummary::infrastructureConfig)).setter(setter(Builder::infrastructureConfig))
.constructor(ModelInfrastructureConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InfrastructureConfig").build())
.build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ModelVariantConfigSummary::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MODEL_NAME_FIELD,
VARIANT_NAME_FIELD, INFRASTRUCTURE_CONFIG_FIELD, STATUS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String modelName;
private final String variantName;
private final ModelInfrastructureConfig infrastructureConfig;
private final String status;
private ModelVariantConfigSummary(BuilderImpl builder) {
this.modelName = builder.modelName;
this.variantName = builder.variantName;
this.infrastructureConfig = builder.infrastructureConfig;
this.status = builder.status;
}
/**
*
* The name of the Amazon SageMaker Model entity.
*
*
* @return The name of the Amazon SageMaker Model entity.
*/
public final String modelName() {
return modelName;
}
/**
*
* The name of the variant.
*
*
* @return The name of the variant.
*/
public final String variantName() {
return variantName;
}
/**
*
* The configuration of the infrastructure that the model has been deployed to.
*
*
* @return The configuration of the infrastructure that the model has been deployed to.
*/
public final ModelInfrastructureConfig infrastructureConfig() {
return infrastructureConfig;
}
/**
*
* The status of deployment for the model variant on the hosted inference endpoint.
*
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen
* after stopping the experiment.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ModelVariantStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of deployment for the model variant on the hosted inference endpoint.
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can only
* happen after stopping the experiment.
*
*
* @see ModelVariantStatus
*/
public final ModelVariantStatus status() {
return ModelVariantStatus.fromValue(status);
}
/**
*
* The status of deployment for the model variant on the hosted inference endpoint.
*
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen
* after stopping the experiment.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ModelVariantStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of deployment for the model variant on the hosted inference endpoint.
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can only
* happen after stopping the experiment.
*
*
* @see ModelVariantStatus
*/
public final String statusAsString() {
return status;
}
@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(modelName());
hashCode = 31 * hashCode + Objects.hashCode(variantName());
hashCode = 31 * hashCode + Objects.hashCode(infrastructureConfig());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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 ModelVariantConfigSummary)) {
return false;
}
ModelVariantConfigSummary other = (ModelVariantConfigSummary) obj;
return Objects.equals(modelName(), other.modelName()) && Objects.equals(variantName(), other.variantName())
&& Objects.equals(infrastructureConfig(), other.infrastructureConfig())
&& Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("ModelVariantConfigSummary").add("ModelName", modelName()).add("VariantName", variantName())
.add("InfrastructureConfig", infrastructureConfig()).add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ModelName":
return Optional.ofNullable(clazz.cast(modelName()));
case "VariantName":
return Optional.ofNullable(clazz.cast(variantName()));
case "InfrastructureConfig":
return Optional.ofNullable(clazz.cast(infrastructureConfig()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
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("ModelName", MODEL_NAME_FIELD);
map.put("VariantName", VARIANT_NAME_FIELD);
map.put("InfrastructureConfig", INFRASTRUCTURE_CONFIG_FIELD);
map.put("Status", STATUS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ModelVariantConfigSummary) 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 Amazon SageMaker Model entity.
*
*
* @param modelName
* The name of the Amazon SageMaker Model entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelName(String modelName);
/**
*
* The name of the variant.
*
*
* @param variantName
* The name of the variant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder variantName(String variantName);
/**
*
* The configuration of the infrastructure that the model has been deployed to.
*
*
* @param infrastructureConfig
* The configuration of the infrastructure that the model has been deployed to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder infrastructureConfig(ModelInfrastructureConfig infrastructureConfig);
/**
*
* The configuration of the infrastructure that the model has been deployed to.
*
* This is a convenience method that creates an instance of the {@link ModelInfrastructureConfig.Builder}
* avoiding the need to create one manually via {@link ModelInfrastructureConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link ModelInfrastructureConfig.Builder#build()} is called immediately
* and its result is passed to {@link #infrastructureConfig(ModelInfrastructureConfig)}.
*
* @param infrastructureConfig
* a consumer that will call methods on {@link ModelInfrastructureConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #infrastructureConfig(ModelInfrastructureConfig)
*/
default Builder infrastructureConfig(Consumer infrastructureConfig) {
return infrastructureConfig(ModelInfrastructureConfig.builder().applyMutation(infrastructureConfig).build());
}
/**
*
* The status of deployment for the model variant on the hosted inference endpoint.
*
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can only
* happen after stopping the experiment.
*
*
*
*
* @param status
* The status of deployment for the model variant on the hosted inference endpoint.
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference
* endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference
* endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference
* endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can
* only happen after stopping the experiment.
*
*
* @see ModelVariantStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelVariantStatus
*/
Builder status(String status);
/**
*
* The status of deployment for the model variant on the hosted inference endpoint.
*
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can only
* happen after stopping the experiment.
*
*
*
*
* @param status
* The status of deployment for the model variant on the hosted inference endpoint.
*
* -
*
* Creating - Amazon SageMaker is preparing the model variant on the hosted inference
* endpoint.
*
*
* -
*
* InService - The model variant is running on the hosted inference endpoint.
*
*
* -
*
* Updating - Amazon SageMaker is updating the model variant on the hosted inference
* endpoint.
*
*
* -
*
* Deleting - Amazon SageMaker is deleting the model variant on the hosted inference
* endpoint.
*
*
* -
*
* Deleted - The model variant has been deleted on the hosted inference endpoint. This can
* only happen after stopping the experiment.
*
*
* @see ModelVariantStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelVariantStatus
*/
Builder status(ModelVariantStatus status);
}
static final class BuilderImpl implements Builder {
private String modelName;
private String variantName;
private ModelInfrastructureConfig infrastructureConfig;
private String status;
private BuilderImpl() {
}
private BuilderImpl(ModelVariantConfigSummary model) {
modelName(model.modelName);
variantName(model.variantName);
infrastructureConfig(model.infrastructureConfig);
status(model.status);
}
public final String getModelName() {
return modelName;
}
public final void setModelName(String modelName) {
this.modelName = modelName;
}
@Override
public final Builder modelName(String modelName) {
this.modelName = modelName;
return this;
}
public final String getVariantName() {
return variantName;
}
public final void setVariantName(String variantName) {
this.variantName = variantName;
}
@Override
public final Builder variantName(String variantName) {
this.variantName = variantName;
return this;
}
public final ModelInfrastructureConfig.Builder getInfrastructureConfig() {
return infrastructureConfig != null ? infrastructureConfig.toBuilder() : null;
}
public final void setInfrastructureConfig(ModelInfrastructureConfig.BuilderImpl infrastructureConfig) {
this.infrastructureConfig = infrastructureConfig != null ? infrastructureConfig.build() : null;
}
@Override
public final Builder infrastructureConfig(ModelInfrastructureConfig infrastructureConfig) {
this.infrastructureConfig = infrastructureConfig;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(ModelVariantStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
@Override
public ModelVariantConfigSummary build() {
return new ModelVariantConfigSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}