software.amazon.awssdk.services.sagemaker.model.DescribeTrialResponse 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.beans.Transient;
import java.time.Instant;
import java.util.Arrays;
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 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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeTrialResponse extends SageMakerResponse implements
ToCopyableBuilder {
private static final SdkField TRIAL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TrialName").getter(getter(DescribeTrialResponse::trialName)).setter(setter(Builder::trialName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrialName").build()).build();
private static final SdkField TRIAL_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TrialArn").getter(getter(DescribeTrialResponse::trialArn)).setter(setter(Builder::trialArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrialArn").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DisplayName").getter(getter(DescribeTrialResponse::displayName)).setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisplayName").build()).build();
private static final SdkField EXPERIMENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExperimentName").getter(getter(DescribeTrialResponse::experimentName))
.setter(setter(Builder::experimentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExperimentName").build()).build();
private static final SdkField SOURCE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Source").getter(getter(DescribeTrialResponse::source)).setter(setter(Builder::source))
.constructor(TrialSource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Source").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeTrialResponse::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(DescribeTrialResponse::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(DescribeTrialResponse::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(DescribeTrialResponse::lastModifiedBy))
.setter(setter(Builder::lastModifiedBy)).constructor(UserContext::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedBy").build()).build();
private static final SdkField METADATA_PROPERTIES_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("MetadataProperties")
.getter(getter(DescribeTrialResponse::metadataProperties)).setter(setter(Builder::metadataProperties))
.constructor(MetadataProperties::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetadataProperties").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRIAL_NAME_FIELD,
TRIAL_ARN_FIELD, DISPLAY_NAME_FIELD, EXPERIMENT_NAME_FIELD, SOURCE_FIELD, CREATION_TIME_FIELD, CREATED_BY_FIELD,
LAST_MODIFIED_TIME_FIELD, LAST_MODIFIED_BY_FIELD, METADATA_PROPERTIES_FIELD));
private final String trialName;
private final String trialArn;
private final String displayName;
private final String experimentName;
private final TrialSource source;
private final Instant creationTime;
private final UserContext createdBy;
private final Instant lastModifiedTime;
private final UserContext lastModifiedBy;
private final MetadataProperties metadataProperties;
private DescribeTrialResponse(BuilderImpl builder) {
super(builder);
this.trialName = builder.trialName;
this.trialArn = builder.trialArn;
this.displayName = builder.displayName;
this.experimentName = builder.experimentName;
this.source = builder.source;
this.creationTime = builder.creationTime;
this.createdBy = builder.createdBy;
this.lastModifiedTime = builder.lastModifiedTime;
this.lastModifiedBy = builder.lastModifiedBy;
this.metadataProperties = builder.metadataProperties;
}
/**
*
* The name of the trial.
*
*
* @return The name of the trial.
*/
public final String trialName() {
return trialName;
}
/**
*
* The Amazon Resource Name (ARN) of the trial.
*
*
* @return The Amazon Resource Name (ARN) of the trial.
*/
public final String trialArn() {
return trialArn;
}
/**
*
* The name of the trial as displayed. If DisplayName isn't specified, TrialName is
* displayed.
*
*
* @return The name of the trial as displayed. If DisplayName isn't specified, TrialName
* is displayed.
*/
public final String displayName() {
return displayName;
}
/**
*
* The name of the experiment the trial is part of.
*
*
* @return The name of the experiment the trial is part of.
*/
public final String experimentName() {
return experimentName;
}
/**
*
* The Amazon Resource Name (ARN) of the source and, optionally, the job type.
*
*
* @return The Amazon Resource Name (ARN) of the source and, optionally, the job type.
*/
public final TrialSource source() {
return source;
}
/**
*
* When the trial was created.
*
*
* @return When the trial was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* Who created the trial.
*
*
* @return Who created the trial.
*/
public final UserContext createdBy() {
return createdBy;
}
/**
*
* When the trial was last modified.
*
*
* @return When the trial was last modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
/**
*
* Who last modified the trial.
*
*
* @return Who last modified the trial.
*/
public final UserContext lastModifiedBy() {
return lastModifiedBy;
}
/**
* Returns the value of the MetadataProperties property for this object.
*
* @return The value of the MetadataProperties property for this object.
*/
public final MetadataProperties metadataProperties() {
return metadataProperties;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(trialName());
hashCode = 31 * hashCode + Objects.hashCode(trialArn());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(experimentName());
hashCode = 31 * hashCode + Objects.hashCode(source());
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(metadataProperties());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeTrialResponse)) {
return false;
}
DescribeTrialResponse other = (DescribeTrialResponse) obj;
return Objects.equals(trialName(), other.trialName()) && Objects.equals(trialArn(), other.trialArn())
&& Objects.equals(displayName(), other.displayName()) && Objects.equals(experimentName(), other.experimentName())
&& Objects.equals(source(), other.source()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(createdBy(), other.createdBy()) && Objects.equals(lastModifiedTime(), other.lastModifiedTime())
&& Objects.equals(lastModifiedBy(), other.lastModifiedBy())
&& Objects.equals(metadataProperties(), other.metadataProperties());
}
/**
* 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("DescribeTrialResponse").add("TrialName", trialName()).add("TrialArn", trialArn())
.add("DisplayName", displayName()).add("ExperimentName", experimentName()).add("Source", source())
.add("CreationTime", creationTime()).add("CreatedBy", createdBy()).add("LastModifiedTime", lastModifiedTime())
.add("LastModifiedBy", lastModifiedBy()).add("MetadataProperties", metadataProperties()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TrialName":
return Optional.ofNullable(clazz.cast(trialName()));
case "TrialArn":
return Optional.ofNullable(clazz.cast(trialArn()));
case "DisplayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "ExperimentName":
return Optional.ofNullable(clazz.cast(experimentName()));
case "Source":
return Optional.ofNullable(clazz.cast(source()));
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 "MetadataProperties":
return Optional.ofNullable(clazz.cast(metadataProperties()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeTrialResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the trial.
*
*
* @param trialName
* The name of the trial.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trialName(String trialName);
/**
*
* The Amazon Resource Name (ARN) of the trial.
*
*
* @param trialArn
* The Amazon Resource Name (ARN) of the trial.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trialArn(String trialArn);
/**
*
* The name of the trial as displayed. If DisplayName isn't specified, TrialName is
* displayed.
*
*
* @param displayName
* The name of the trial as displayed. If DisplayName isn't specified,
* TrialName is displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The name of the experiment the trial is part of.
*
*
* @param experimentName
* The name of the experiment the trial is part of.
* @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 source and, optionally, the job type.
*
*
* @param source
* The Amazon Resource Name (ARN) of the source and, optionally, the job type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder source(TrialSource source);
/**
*
* The Amazon Resource Name (ARN) of the source and, optionally, the job type.
*
* This is a convenience that creates an instance of the {@link TrialSource.Builder} avoiding the need to create
* one manually via {@link TrialSource#builder()}.
*
* When the {@link Consumer} completes, {@link TrialSource.Builder#build()} is called immediately and its result
* is passed to {@link #source(TrialSource)}.
*
* @param source
* a consumer that will call methods on {@link TrialSource.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #source(TrialSource)
*/
default Builder source(Consumer source) {
return source(TrialSource.builder().applyMutation(source).build());
}
/**
*
* When the trial was created.
*
*
* @param creationTime
* When the trial was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* Who created the trial.
*
*
* @param createdBy
* Who created the trial.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdBy(UserContext createdBy);
/**
*
* Who created the trial.
*
* This is a convenience 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 trial was last modified.
*
*
* @param lastModifiedTime
* When the trial was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
/**
*
* Who last modified the trial.
*
*
* @param lastModifiedBy
* Who last modified the trial.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedBy(UserContext lastModifiedBy);
/**
*
* Who last modified the trial.
*
* This is a convenience 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());
}
/**
* Sets the value of the MetadataProperties property for this object.
*
* @param metadataProperties
* The new value for the MetadataProperties property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metadataProperties(MetadataProperties metadataProperties);
/**
* Sets the value of the MetadataProperties property for this object.
*
* This is a convenience that creates an instance of the {@link MetadataProperties.Builder} avoiding the need to
* create one manually via {@link MetadataProperties#builder()}.
*
* When the {@link Consumer} completes, {@link MetadataProperties.Builder#build()} is called immediately and its
* result is passed to {@link #metadataProperties(MetadataProperties)}.
*
* @param metadataProperties
* a consumer that will call methods on {@link MetadataProperties.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #metadataProperties(MetadataProperties)
*/
default Builder metadataProperties(Consumer metadataProperties) {
return metadataProperties(MetadataProperties.builder().applyMutation(metadataProperties).build());
}
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private String trialName;
private String trialArn;
private String displayName;
private String experimentName;
private TrialSource source;
private Instant creationTime;
private UserContext createdBy;
private Instant lastModifiedTime;
private UserContext lastModifiedBy;
private MetadataProperties metadataProperties;
private BuilderImpl() {
}
private BuilderImpl(DescribeTrialResponse model) {
super(model);
trialName(model.trialName);
trialArn(model.trialArn);
displayName(model.displayName);
experimentName(model.experimentName);
source(model.source);
creationTime(model.creationTime);
createdBy(model.createdBy);
lastModifiedTime(model.lastModifiedTime);
lastModifiedBy(model.lastModifiedBy);
metadataProperties(model.metadataProperties);
}
public final String getTrialName() {
return trialName;
}
public final void setTrialName(String trialName) {
this.trialName = trialName;
}
@Override
@Transient
public final Builder trialName(String trialName) {
this.trialName = trialName;
return this;
}
public final String getTrialArn() {
return trialArn;
}
public final void setTrialArn(String trialArn) {
this.trialArn = trialArn;
}
@Override
@Transient
public final Builder trialArn(String trialArn) {
this.trialArn = trialArn;
return this;
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
@Transient
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getExperimentName() {
return experimentName;
}
public final void setExperimentName(String experimentName) {
this.experimentName = experimentName;
}
@Override
@Transient
public final Builder experimentName(String experimentName) {
this.experimentName = experimentName;
return this;
}
public final TrialSource.Builder getSource() {
return source != null ? source.toBuilder() : null;
}
public final void setSource(TrialSource.BuilderImpl source) {
this.source = source != null ? source.build() : null;
}
@Override
@Transient
public final Builder source(TrialSource source) {
this.source = source;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
@Transient
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
@Transient
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
@Transient
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
@Transient
public final Builder lastModifiedBy(UserContext lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy;
return this;
}
public final MetadataProperties.Builder getMetadataProperties() {
return metadataProperties != null ? metadataProperties.toBuilder() : null;
}
public final void setMetadataProperties(MetadataProperties.BuilderImpl metadataProperties) {
this.metadataProperties = metadataProperties != null ? metadataProperties.build() : null;
}
@Override
@Transient
public final Builder metadataProperties(MetadataProperties metadataProperties) {
this.metadataProperties = metadataProperties;
return this;
}
@Override
public DescribeTrialResponse build() {
return new DescribeTrialResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy