software.amazon.awssdk.services.sagemaker.model.ModelPackageValidationSpecification 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.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;
/**
*
* Specifies batch transform jobs that SageMaker runs to validate your model package.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModelPackageValidationSpecification implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VALIDATION_ROLE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ValidationRole").getter(getter(ModelPackageValidationSpecification::validationRole))
.setter(setter(Builder::validationRole))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ValidationRole").build()).build();
private static final SdkField> VALIDATION_PROFILES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ValidationProfiles")
.getter(getter(ModelPackageValidationSpecification::validationProfiles))
.setter(setter(Builder::validationProfiles))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ValidationProfiles").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ModelPackageValidationProfile::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VALIDATION_ROLE_FIELD,
VALIDATION_PROFILES_FIELD));
private static final long serialVersionUID = 1L;
private final String validationRole;
private final List validationProfiles;
private ModelPackageValidationSpecification(BuilderImpl builder) {
this.validationRole = builder.validationRole;
this.validationProfiles = builder.validationProfiles;
}
/**
*
* The IAM roles to be used for the validation of the model package.
*
*
* @return The IAM roles to be used for the validation of the model package.
*/
public final String validationRole() {
return validationRole;
}
/**
* For responses, this returns true if the service returned a value for the ValidationProfiles 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 hasValidationProfiles() {
return validationProfiles != null && !(validationProfiles instanceof SdkAutoConstructList);
}
/**
*
* An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job
* that SageMaker runs to validate your model package.
*
*
* 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 #hasValidationProfiles} method.
*
*
* @return An array of ModelPackageValidationProfile objects, each of which specifies a batch transform
* job that SageMaker runs to validate your model package.
*/
public final List validationProfiles() {
return validationProfiles;
}
@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(validationRole());
hashCode = 31 * hashCode + Objects.hashCode(hasValidationProfiles() ? validationProfiles() : 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 ModelPackageValidationSpecification)) {
return false;
}
ModelPackageValidationSpecification other = (ModelPackageValidationSpecification) obj;
return Objects.equals(validationRole(), other.validationRole())
&& hasValidationProfiles() == other.hasValidationProfiles()
&& Objects.equals(validationProfiles(), other.validationProfiles());
}
/**
* 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("ModelPackageValidationSpecification").add("ValidationRole", validationRole())
.add("ValidationProfiles", hasValidationProfiles() ? validationProfiles() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ValidationRole":
return Optional.ofNullable(clazz.cast(validationRole()));
case "ValidationProfiles":
return Optional.ofNullable(clazz.cast(validationProfiles()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModelPackageValidationSpecification) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The IAM roles to be used for the validation of the model package.
*
*
* @param validationRole
* The IAM roles to be used for the validation of the model package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validationRole(String validationRole);
/**
*
* An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job
* that SageMaker runs to validate your model package.
*
*
* @param validationProfiles
* An array of ModelPackageValidationProfile objects, each of which specifies a batch
* transform job that SageMaker runs to validate your model package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validationProfiles(Collection validationProfiles);
/**
*
* An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job
* that SageMaker runs to validate your model package.
*
*
* @param validationProfiles
* An array of ModelPackageValidationProfile objects, each of which specifies a batch
* transform job that SageMaker runs to validate your model package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validationProfiles(ModelPackageValidationProfile... validationProfiles);
/**
*
* An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job
* that SageMaker runs to validate your model package.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.ModelPackageValidationProfile.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.sagemaker.model.ModelPackageValidationProfile#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.ModelPackageValidationProfile.Builder#build()} is
* called immediately and its result is passed to {@link
* #validationProfiles(List)}.
*
* @param validationProfiles
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.ModelPackageValidationProfile.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #validationProfiles(java.util.Collection)
*/
Builder validationProfiles(Consumer... validationProfiles);
}
static final class BuilderImpl implements Builder {
private String validationRole;
private List validationProfiles = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ModelPackageValidationSpecification model) {
validationRole(model.validationRole);
validationProfiles(model.validationProfiles);
}
public final String getValidationRole() {
return validationRole;
}
public final void setValidationRole(String validationRole) {
this.validationRole = validationRole;
}
@Override
public final Builder validationRole(String validationRole) {
this.validationRole = validationRole;
return this;
}
public final List getValidationProfiles() {
List result = ModelPackageValidationProfilesCopier
.copyToBuilder(this.validationProfiles);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setValidationProfiles(Collection validationProfiles) {
this.validationProfiles = ModelPackageValidationProfilesCopier.copyFromBuilder(validationProfiles);
}
@Override
public final Builder validationProfiles(Collection validationProfiles) {
this.validationProfiles = ModelPackageValidationProfilesCopier.copy(validationProfiles);
return this;
}
@Override
@SafeVarargs
public final Builder validationProfiles(ModelPackageValidationProfile... validationProfiles) {
validationProfiles(Arrays.asList(validationProfiles));
return this;
}
@Override
@SafeVarargs
public final Builder validationProfiles(Consumer... validationProfiles) {
validationProfiles(Stream.of(validationProfiles)
.map(c -> ModelPackageValidationProfile.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ModelPackageValidationSpecification build() {
return new ModelPackageValidationSpecification(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}