software.amazon.awssdk.services.sagemaker.model.Experiment 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.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;
/**
*
* The properties of an experiment as returned by the Search API.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Experiment implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField EXPERIMENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExperimentName").getter(getter(Experiment::experimentName)).setter(setter(Builder::experimentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExperimentName").build()).build();
private static final SdkField EXPERIMENT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExperimentArn").getter(getter(Experiment::experimentArn)).setter(setter(Builder::experimentArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExperimentArn").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DisplayName").getter(getter(Experiment::displayName)).setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisplayName").build()).build();
private static final SdkField SOURCE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Source").getter(getter(Experiment::source)).setter(setter(Builder::source))
.constructor(ExperimentSource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Source").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Experiment::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(Experiment::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(Experiment::createdBy)).setter(setter(Builder::createdBy))
.constructor(UserContext::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedBy").build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTime").getter(getter(Experiment::lastModifiedTime))
.setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final SdkField LAST_MODIFIED_BY_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("LastModifiedBy").getter(getter(Experiment::lastModifiedBy)).setter(setter(Builder::lastModifiedBy))
.constructor(UserContext::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedBy").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(Experiment::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(EXPERIMENT_NAME_FIELD,
EXPERIMENT_ARN_FIELD, DISPLAY_NAME_FIELD, SOURCE_FIELD, DESCRIPTION_FIELD, CREATION_TIME_FIELD, CREATED_BY_FIELD,
LAST_MODIFIED_TIME_FIELD, LAST_MODIFIED_BY_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String experimentName;
private final String experimentArn;
private final String displayName;
private final ExperimentSource source;
private final String description;
private final Instant creationTime;
private final UserContext createdBy;
private final Instant lastModifiedTime;
private final UserContext lastModifiedBy;
private final List tags;
private Experiment(BuilderImpl builder) {
this.experimentName = builder.experimentName;
this.experimentArn = builder.experimentArn;
this.displayName = builder.displayName;
this.source = builder.source;
this.description = builder.description;
this.creationTime = builder.creationTime;
this.createdBy = builder.createdBy;
this.lastModifiedTime = builder.lastModifiedTime;
this.lastModifiedBy = builder.lastModifiedBy;
this.tags = builder.tags;
}
/**
*
* The name of the experiment.
*
*
* @return The name of the experiment.
*/
public final String experimentName() {
return experimentName;
}
/**
*
* The Amazon Resource Name (ARN) of the experiment.
*
*
* @return The Amazon Resource Name (ARN) of the experiment.
*/
public final String experimentArn() {
return experimentArn;
}
/**
*
* The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName
* is displayed.
*
*
* @return The name of the experiment as displayed. If DisplayName isn't specified,
* ExperimentName is displayed.
*/
public final String displayName() {
return displayName;
}
/**
* Returns the value of the Source property for this object.
*
* @return The value of the Source property for this object.
*/
public final ExperimentSource source() {
return source;
}
/**
*
* The description of the experiment.
*
*
* @return The description of the experiment.
*/
public final String description() {
return description;
}
/**
*
* When the experiment was created.
*
*
* @return When the experiment was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* Who created the experiment.
*
*
* @return Who created the experiment.
*/
public final UserContext createdBy() {
return createdBy;
}
/**
*
* When the experiment was last modified.
*
*
* @return When the experiment was last modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
/**
* Returns the value of the LastModifiedBy property for this object.
*
* @return The value of the LastModifiedBy property for this object.
*/
public final UserContext lastModifiedBy() {
return lastModifiedBy;
}
/**
* 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);
}
/**
*
* The list of tags that are associated with the experiment. You can use Search API to search on the tags.
*
*
* 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 The list of tags that are associated with the experiment. You can use Search API to search on the
* tags.
*/
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(experimentName());
hashCode = 31 * hashCode + Objects.hashCode(experimentArn());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(source());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(createdBy());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedBy());
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 Experiment)) {
return false;
}
Experiment other = (Experiment) obj;
return Objects.equals(experimentName(), other.experimentName()) && Objects.equals(experimentArn(), other.experimentArn())
&& Objects.equals(displayName(), other.displayName()) && Objects.equals(source(), other.source())
&& Objects.equals(description(), other.description()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(createdBy(), other.createdBy()) && Objects.equals(lastModifiedTime(), other.lastModifiedTime())
&& Objects.equals(lastModifiedBy(), other.lastModifiedBy()) && 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("Experiment").add("ExperimentName", experimentName()).add("ExperimentArn", experimentArn())
.add("DisplayName", displayName()).add("Source", source()).add("Description", description())
.add("CreationTime", creationTime()).add("CreatedBy", createdBy()).add("LastModifiedTime", lastModifiedTime())
.add("LastModifiedBy", lastModifiedBy()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ExperimentName":
return Optional.ofNullable(clazz.cast(experimentName()));
case "ExperimentArn":
return Optional.ofNullable(clazz.cast(experimentArn()));
case "DisplayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "Source":
return Optional.ofNullable(clazz.cast(source()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "CreatedBy":
return Optional.ofNullable(clazz.cast(createdBy()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
case "LastModifiedBy":
return Optional.ofNullable(clazz.cast(lastModifiedBy()));
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((Experiment) 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 experiment.
*
*
* @param experimentName
* The name of the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder experimentName(String experimentName);
/**
*
* The Amazon Resource Name (ARN) of the experiment.
*
*
* @param experimentArn
* The Amazon Resource Name (ARN) of the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder experimentArn(String experimentArn);
/**
*
* The name of the experiment as displayed. If DisplayName isn't specified,
* ExperimentName is displayed.
*
*
* @param displayName
* The name of the experiment as displayed. If DisplayName isn't specified,
* ExperimentName is displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
* Sets the value of the Source property for this object.
*
* @param source
* The new value for the Source property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder source(ExperimentSource source);
/**
* Sets the value of the Source property for this object.
*
* This is a convenience method that creates an instance of the {@link ExperimentSource.Builder} avoiding the
* need to create one manually via {@link ExperimentSource#builder()}.
*
* When the {@link Consumer} completes, {@link ExperimentSource.Builder#build()} is called immediately and its
* result is passed to {@link #source(ExperimentSource)}.
*
* @param source
* a consumer that will call methods on {@link ExperimentSource.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #source(ExperimentSource)
*/
default Builder source(Consumer source) {
return source(ExperimentSource.builder().applyMutation(source).build());
}
/**
*
* The description of the experiment.
*
*
* @param description
* The description of the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* When the experiment was created.
*
*
* @param creationTime
* When the experiment was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* Who created the experiment.
*
*
* @param createdBy
* Who created the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdBy(UserContext createdBy);
/**
*
* Who created the experiment.
*
* 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());
}
/**
*
* When the experiment was last modified.
*
*
* @param lastModifiedTime
* When the experiment was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
/**
* Sets the value of the LastModifiedBy property for this object.
*
* @param lastModifiedBy
* The new value for the LastModifiedBy property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedBy(UserContext lastModifiedBy);
/**
* Sets the value of the LastModifiedBy 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 #lastModifiedBy(UserContext)}.
*
* @param lastModifiedBy
* 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 #lastModifiedBy(UserContext)
*/
default Builder lastModifiedBy(Consumer lastModifiedBy) {
return lastModifiedBy(UserContext.builder().applyMutation(lastModifiedBy).build());
}
/**
*
* The list of tags that are associated with the experiment. You can use Search API to search on the
* tags.
*
*
* @param tags
* The list of tags that are associated with the experiment. You can use Search API to search on
* the tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The list of tags that are associated with the experiment. You can use Search API to search on the
* tags.
*
*
* @param tags
* The list of tags that are associated with the experiment. You can use Search API to search on
* the tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The list of tags that are associated with the experiment. You can use Search API to search on the
* tags.
*
* This is a convenience method that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl implements Builder {
private String experimentName;
private String experimentArn;
private String displayName;
private ExperimentSource source;
private String description;
private Instant creationTime;
private UserContext createdBy;
private Instant lastModifiedTime;
private UserContext lastModifiedBy;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Experiment model) {
experimentName(model.experimentName);
experimentArn(model.experimentArn);
displayName(model.displayName);
source(model.source);
description(model.description);
creationTime(model.creationTime);
createdBy(model.createdBy);
lastModifiedTime(model.lastModifiedTime);
lastModifiedBy(model.lastModifiedBy);
tags(model.tags);
}
public final String getExperimentName() {
return experimentName;
}
public final void setExperimentName(String experimentName) {
this.experimentName = experimentName;
}
@Override
public final Builder experimentName(String experimentName) {
this.experimentName = experimentName;
return this;
}
public final String getExperimentArn() {
return experimentArn;
}
public final void setExperimentArn(String experimentArn) {
this.experimentArn = experimentArn;
}
@Override
public final Builder experimentArn(String experimentArn) {
this.experimentArn = experimentArn;
return this;
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final ExperimentSource.Builder getSource() {
return source != null ? source.toBuilder() : null;
}
public final void setSource(ExperimentSource.BuilderImpl source) {
this.source = source != null ? source.build() : null;
}
@Override
public final Builder source(ExperimentSource source) {
this.source = source;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
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 Instant getLastModifiedTime() {
return lastModifiedTime;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
public final UserContext.Builder getLastModifiedBy() {
return lastModifiedBy != null ? lastModifiedBy.toBuilder() : null;
}
public final void setLastModifiedBy(UserContext.BuilderImpl lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy != null ? lastModifiedBy.build() : null;
}
@Override
public final Builder lastModifiedBy(UserContext lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy;
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 Experiment build() {
return new Experiment(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy