software.amazon.awssdk.services.sagemaker.model.ModelPackageGroup 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.time.Instant;
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;
/**
*
* A group of versioned models in the model registry.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModelPackageGroup implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MODEL_PACKAGE_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelPackageGroupName").getter(getter(ModelPackageGroup::modelPackageGroupName))
.setter(setter(Builder::modelPackageGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelPackageGroupName").build())
.build();
private static final SdkField MODEL_PACKAGE_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelPackageGroupArn").getter(getter(ModelPackageGroup::modelPackageGroupArn))
.setter(setter(Builder::modelPackageGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelPackageGroupArn").build())
.build();
private static final SdkField MODEL_PACKAGE_GROUP_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ModelPackageGroupDescription")
.getter(getter(ModelPackageGroup::modelPackageGroupDescription))
.setter(setter(Builder::modelPackageGroupDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelPackageGroupDescription")
.build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(ModelPackageGroup::creationTime)).setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField CREATED_BY_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("CreatedBy").getter(getter(ModelPackageGroup::createdBy)).setter(setter(Builder::createdBy))
.constructor(UserContext::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedBy").build()).build();
private static final SdkField MODEL_PACKAGE_GROUP_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelPackageGroupStatus").getter(getter(ModelPackageGroup::modelPackageGroupStatusAsString))
.setter(setter(Builder::modelPackageGroupStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelPackageGroupStatus").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(ModelPackageGroup::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
MODEL_PACKAGE_GROUP_NAME_FIELD, MODEL_PACKAGE_GROUP_ARN_FIELD, MODEL_PACKAGE_GROUP_DESCRIPTION_FIELD,
CREATION_TIME_FIELD, CREATED_BY_FIELD, MODEL_PACKAGE_GROUP_STATUS_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String modelPackageGroupName;
private final String modelPackageGroupArn;
private final String modelPackageGroupDescription;
private final Instant creationTime;
private final UserContext createdBy;
private final String modelPackageGroupStatus;
private final List tags;
private ModelPackageGroup(BuilderImpl builder) {
this.modelPackageGroupName = builder.modelPackageGroupName;
this.modelPackageGroupArn = builder.modelPackageGroupArn;
this.modelPackageGroupDescription = builder.modelPackageGroupDescription;
this.creationTime = builder.creationTime;
this.createdBy = builder.createdBy;
this.modelPackageGroupStatus = builder.modelPackageGroupStatus;
this.tags = builder.tags;
}
/**
*
* The name of the model group.
*
*
* @return The name of the model group.
*/
public final String modelPackageGroupName() {
return modelPackageGroupName;
}
/**
*
* The Amazon Resource Name (ARN) of the model group.
*
*
* @return The Amazon Resource Name (ARN) of the model group.
*/
public final String modelPackageGroupArn() {
return modelPackageGroupArn;
}
/**
*
* The description for the model group.
*
*
* @return The description for the model group.
*/
public final String modelPackageGroupDescription() {
return modelPackageGroupDescription;
}
/**
*
* The time that the model group was created.
*
*
* @return The time that the model group was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
* Returns the value of the CreatedBy property for this object.
*
* @return The value of the CreatedBy property for this object.
*/
public final UserContext createdBy() {
return createdBy;
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #modelPackageGroupStatus} will return {@link ModelPackageGroupStatus#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #modelPackageGroupStatusAsString}.
*
*
* @return The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @see ModelPackageGroupStatus
*/
public final ModelPackageGroupStatus modelPackageGroupStatus() {
return ModelPackageGroupStatus.fromValue(modelPackageGroupStatus);
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #modelPackageGroupStatus} will return {@link ModelPackageGroupStatus#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #modelPackageGroupStatusAsString}.
*
*
* @return The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @see ModelPackageGroupStatus
*/
public final String modelPackageGroupStatusAsString() {
return modelPackageGroupStatus;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources
* in the Amazon Web Services General Reference Guide.
*
*
* 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 #hasTags} method.
*
*
* @return A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*/
public final List tags() {
return tags;
}
@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(modelPackageGroupName());
hashCode = 31 * hashCode + Objects.hashCode(modelPackageGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(modelPackageGroupDescription());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(createdBy());
hashCode = 31 * hashCode + Objects.hashCode(modelPackageGroupStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 ModelPackageGroup)) {
return false;
}
ModelPackageGroup other = (ModelPackageGroup) obj;
return Objects.equals(modelPackageGroupName(), other.modelPackageGroupName())
&& Objects.equals(modelPackageGroupArn(), other.modelPackageGroupArn())
&& Objects.equals(modelPackageGroupDescription(), other.modelPackageGroupDescription())
&& Objects.equals(creationTime(), other.creationTime()) && Objects.equals(createdBy(), other.createdBy())
&& Objects.equals(modelPackageGroupStatusAsString(), other.modelPackageGroupStatusAsString())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("ModelPackageGroup").add("ModelPackageGroupName", modelPackageGroupName())
.add("ModelPackageGroupArn", modelPackageGroupArn())
.add("ModelPackageGroupDescription", modelPackageGroupDescription()).add("CreationTime", creationTime())
.add("CreatedBy", createdBy()).add("ModelPackageGroupStatus", modelPackageGroupStatusAsString())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ModelPackageGroupName":
return Optional.ofNullable(clazz.cast(modelPackageGroupName()));
case "ModelPackageGroupArn":
return Optional.ofNullable(clazz.cast(modelPackageGroupArn()));
case "ModelPackageGroupDescription":
return Optional.ofNullable(clazz.cast(modelPackageGroupDescription()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "CreatedBy":
return Optional.ofNullable(clazz.cast(createdBy()));
case "ModelPackageGroupStatus":
return Optional.ofNullable(clazz.cast(modelPackageGroupStatusAsString()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModelPackageGroup) 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 model group.
*
*
* @param modelPackageGroupName
* The name of the model group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelPackageGroupName(String modelPackageGroupName);
/**
*
* The Amazon Resource Name (ARN) of the model group.
*
*
* @param modelPackageGroupArn
* The Amazon Resource Name (ARN) of the model group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelPackageGroupArn(String modelPackageGroupArn);
/**
*
* The description for the model group.
*
*
* @param modelPackageGroupDescription
* The description for the model group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelPackageGroupDescription(String modelPackageGroupDescription);
/**
*
* The time that the model group was created.
*
*
* @param creationTime
* The time that the model group was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
* Sets the value of the CreatedBy property for this object.
*
* @param createdBy
* The new value for the CreatedBy property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdBy(UserContext createdBy);
/**
* Sets the value of the CreatedBy property for this object.
*
* This is a convenience method that creates an instance of the {@link UserContext.Builder} avoiding the need to
* create one manually via {@link UserContext#builder()}.
*
*
* When the {@link Consumer} completes, {@link UserContext.Builder#build()} is called immediately and its result
* is passed to {@link #createdBy(UserContext)}.
*
* @param createdBy
* a consumer that will call methods on {@link UserContext.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #createdBy(UserContext)
*/
default Builder createdBy(Consumer createdBy) {
return createdBy(UserContext.builder().applyMutation(createdBy).build());
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* @param modelPackageGroupStatus
* The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @see ModelPackageGroupStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelPackageGroupStatus
*/
Builder modelPackageGroupStatus(String modelPackageGroupStatus);
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* @param modelPackageGroupStatus
* The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @see ModelPackageGroupStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelPackageGroupStatus
*/
Builder modelPackageGroupStatus(ModelPackageGroupStatus modelPackageGroupStatus);
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*
*
* @param tags
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*
*
* @param tags
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.sagemaker.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl implements Builder {
private String modelPackageGroupName;
private String modelPackageGroupArn;
private String modelPackageGroupDescription;
private Instant creationTime;
private UserContext createdBy;
private String modelPackageGroupStatus;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ModelPackageGroup model) {
modelPackageGroupName(model.modelPackageGroupName);
modelPackageGroupArn(model.modelPackageGroupArn);
modelPackageGroupDescription(model.modelPackageGroupDescription);
creationTime(model.creationTime);
createdBy(model.createdBy);
modelPackageGroupStatus(model.modelPackageGroupStatus);
tags(model.tags);
}
public final String getModelPackageGroupName() {
return modelPackageGroupName;
}
public final void setModelPackageGroupName(String modelPackageGroupName) {
this.modelPackageGroupName = modelPackageGroupName;
}
@Override
public final Builder modelPackageGroupName(String modelPackageGroupName) {
this.modelPackageGroupName = modelPackageGroupName;
return this;
}
public final String getModelPackageGroupArn() {
return modelPackageGroupArn;
}
public final void setModelPackageGroupArn(String modelPackageGroupArn) {
this.modelPackageGroupArn = modelPackageGroupArn;
}
@Override
public final Builder modelPackageGroupArn(String modelPackageGroupArn) {
this.modelPackageGroupArn = modelPackageGroupArn;
return this;
}
public final String getModelPackageGroupDescription() {
return modelPackageGroupDescription;
}
public final void setModelPackageGroupDescription(String modelPackageGroupDescription) {
this.modelPackageGroupDescription = modelPackageGroupDescription;
}
@Override
public final Builder modelPackageGroupDescription(String modelPackageGroupDescription) {
this.modelPackageGroupDescription = modelPackageGroupDescription;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final UserContext.Builder getCreatedBy() {
return createdBy != null ? createdBy.toBuilder() : null;
}
public final void setCreatedBy(UserContext.BuilderImpl createdBy) {
this.createdBy = createdBy != null ? createdBy.build() : null;
}
@Override
public final Builder createdBy(UserContext createdBy) {
this.createdBy = createdBy;
return this;
}
public final String getModelPackageGroupStatus() {
return modelPackageGroupStatus;
}
public final void setModelPackageGroupStatus(String modelPackageGroupStatus) {
this.modelPackageGroupStatus = modelPackageGroupStatus;
}
@Override
public final Builder modelPackageGroupStatus(String modelPackageGroupStatus) {
this.modelPackageGroupStatus = modelPackageGroupStatus;
return this;
}
@Override
public final Builder modelPackageGroupStatus(ModelPackageGroupStatus modelPackageGroupStatus) {
this.modelPackageGroupStatus(modelPackageGroupStatus == null ? null : modelPackageGroupStatus.toString());
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ModelPackageGroup build() {
return new ModelPackageGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}