com.amazonaws.services.sagemaker.model.Trial Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 com.amazonaws.services.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The properties of a trial as returned by the Search API.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Trial implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the trial.
*
*/
private String trialName;
/**
*
* The Amazon Resource Name (ARN) of the trial.
*
*/
private String trialArn;
/**
*
* The name of the trial as displayed. If DisplayName isn't specified, TrialName is
* displayed.
*
*/
private String displayName;
/**
*
* The name of the experiment the trial is part of.
*
*/
private String experimentName;
private TrialSource source;
/**
*
* When the trial was created.
*
*/
private java.util.Date creationTime;
/**
*
* Who created the trial.
*
*/
private UserContext createdBy;
/**
*
* Who last modified the trial.
*
*/
private java.util.Date lastModifiedTime;
private UserContext lastModifiedBy;
private MetadataProperties metadataProperties;
/**
*
* The list of tags that are associated with the trial. You can use Search API to search on the
* tags.
*
*/
private java.util.List tags;
/**
*
* A list of the components associated with the trial. For each component, a summary of the component's properties
* is included.
*
*/
private java.util.List trialComponentSummaries;
/**
*
* The name of the trial.
*
*
* @param trialName
* The name of the trial.
*/
public void setTrialName(String trialName) {
this.trialName = trialName;
}
/**
*
* The name of the trial.
*
*
* @return The name of the trial.
*/
public String getTrialName() {
return this.trialName;
}
/**
*
* 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.
*/
public Trial withTrialName(String trialName) {
setTrialName(trialName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the trial.
*
*
* @param trialArn
* The Amazon Resource Name (ARN) of the trial.
*/
public void setTrialArn(String trialArn) {
this.trialArn = trialArn;
}
/**
*
* The Amazon Resource Name (ARN) of the trial.
*
*
* @return The Amazon Resource Name (ARN) of the trial.
*/
public String getTrialArn() {
return this.trialArn;
}
/**
*
* 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.
*/
public Trial withTrialArn(String trialArn) {
setTrialArn(trialArn);
return this;
}
/**
*
* 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.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* 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 String getDisplayName() {
return this.displayName;
}
/**
*
* 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.
*/
public Trial withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The name of the experiment the trial is part of.
*
*
* @param experimentName
* The name of the experiment the trial is part of.
*/
public void setExperimentName(String experimentName) {
this.experimentName = experimentName;
}
/**
*
* The name of the experiment the trial is part of.
*
*
* @return The name of the experiment the trial is part of.
*/
public String getExperimentName() {
return this.experimentName;
}
/**
*
* 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.
*/
public Trial withExperimentName(String experimentName) {
setExperimentName(experimentName);
return this;
}
/**
* @param source
*/
public void setSource(TrialSource source) {
this.source = source;
}
/**
* @return
*/
public TrialSource getSource() {
return this.source;
}
/**
* @param source
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trial withSource(TrialSource source) {
setSource(source);
return this;
}
/**
*
* When the trial was created.
*
*
* @param creationTime
* When the trial was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the trial was created.
*
*
* @return When the trial was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* 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.
*/
public Trial withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* Who created the trial.
*
*
* @param createdBy
* Who created the trial.
*/
public void setCreatedBy(UserContext createdBy) {
this.createdBy = createdBy;
}
/**
*
* Who created the trial.
*
*
* @return Who created the trial.
*/
public UserContext getCreatedBy() {
return this.createdBy;
}
/**
*
* 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.
*/
public Trial withCreatedBy(UserContext createdBy) {
setCreatedBy(createdBy);
return this;
}
/**
*
* Who last modified the trial.
*
*
* @param lastModifiedTime
* Who last modified the trial.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* Who last modified the trial.
*
*
* @return Who last modified the trial.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* Who last modified the trial.
*
*
* @param lastModifiedTime
* Who last modified the trial.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trial withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
* @param lastModifiedBy
*/
public void setLastModifiedBy(UserContext lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy;
}
/**
* @return
*/
public UserContext getLastModifiedBy() {
return this.lastModifiedBy;
}
/**
* @param lastModifiedBy
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trial withLastModifiedBy(UserContext lastModifiedBy) {
setLastModifiedBy(lastModifiedBy);
return this;
}
/**
* @param metadataProperties
*/
public void setMetadataProperties(MetadataProperties metadataProperties) {
this.metadataProperties = metadataProperties;
}
/**
* @return
*/
public MetadataProperties getMetadataProperties() {
return this.metadataProperties;
}
/**
* @param metadataProperties
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trial withMetadataProperties(MetadataProperties metadataProperties) {
setMetadataProperties(metadataProperties);
return this;
}
/**
*
* The list of tags that are associated with the trial. You can use Search API to search on the
* tags.
*
*
* @return The list of tags that are associated with the trial. You can use Search API to search
* on the tags.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The list of tags that are associated with the trial. You can use Search API to search on the
* tags.
*
*
* @param tags
* The list of tags that are associated with the trial. You can use Search API to search
* on the tags.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The list of tags that are associated with the trial. You can use Search API to search on the
* tags.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* The list of tags that are associated with the trial. 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.
*/
public Trial withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The list of tags that are associated with the trial. You can use Search API to search on the
* tags.
*
*
* @param tags
* The list of tags that are associated with the trial. 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.
*/
public Trial withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* A list of the components associated with the trial. For each component, a summary of the component's properties
* is included.
*
*
* @return A list of the components associated with the trial. For each component, a summary of the component's
* properties is included.
*/
public java.util.List getTrialComponentSummaries() {
return trialComponentSummaries;
}
/**
*
* A list of the components associated with the trial. For each component, a summary of the component's properties
* is included.
*
*
* @param trialComponentSummaries
* A list of the components associated with the trial. For each component, a summary of the component's
* properties is included.
*/
public void setTrialComponentSummaries(java.util.Collection trialComponentSummaries) {
if (trialComponentSummaries == null) {
this.trialComponentSummaries = null;
return;
}
this.trialComponentSummaries = new java.util.ArrayList(trialComponentSummaries);
}
/**
*
* A list of the components associated with the trial. For each component, a summary of the component's properties
* is included.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTrialComponentSummaries(java.util.Collection)} or
* {@link #withTrialComponentSummaries(java.util.Collection)} if you want to override the existing values.
*
*
* @param trialComponentSummaries
* A list of the components associated with the trial. For each component, a summary of the component's
* properties is included.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trial withTrialComponentSummaries(TrialComponentSimpleSummary... trialComponentSummaries) {
if (this.trialComponentSummaries == null) {
setTrialComponentSummaries(new java.util.ArrayList(trialComponentSummaries.length));
}
for (TrialComponentSimpleSummary ele : trialComponentSummaries) {
this.trialComponentSummaries.add(ele);
}
return this;
}
/**
*
* A list of the components associated with the trial. For each component, a summary of the component's properties
* is included.
*
*
* @param trialComponentSummaries
* A list of the components associated with the trial. For each component, a summary of the component's
* properties is included.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trial withTrialComponentSummaries(java.util.Collection trialComponentSummaries) {
setTrialComponentSummaries(trialComponentSummaries);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTrialName() != null)
sb.append("TrialName: ").append(getTrialName()).append(",");
if (getTrialArn() != null)
sb.append("TrialArn: ").append(getTrialArn()).append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append(getDisplayName()).append(",");
if (getExperimentName() != null)
sb.append("ExperimentName: ").append(getExperimentName()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getCreatedBy() != null)
sb.append("CreatedBy: ").append(getCreatedBy()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getLastModifiedBy() != null)
sb.append("LastModifiedBy: ").append(getLastModifiedBy()).append(",");
if (getMetadataProperties() != null)
sb.append("MetadataProperties: ").append(getMetadataProperties()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getTrialComponentSummaries() != null)
sb.append("TrialComponentSummaries: ").append(getTrialComponentSummaries());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Trial == false)
return false;
Trial other = (Trial) obj;
if (other.getTrialName() == null ^ this.getTrialName() == null)
return false;
if (other.getTrialName() != null && other.getTrialName().equals(this.getTrialName()) == false)
return false;
if (other.getTrialArn() == null ^ this.getTrialArn() == null)
return false;
if (other.getTrialArn() != null && other.getTrialArn().equals(this.getTrialArn()) == false)
return false;
if (other.getDisplayName() == null ^ this.getDisplayName() == null)
return false;
if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false)
return false;
if (other.getExperimentName() == null ^ this.getExperimentName() == null)
return false;
if (other.getExperimentName() != null && other.getExperimentName().equals(this.getExperimentName()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getCreatedBy() == null ^ this.getCreatedBy() == null)
return false;
if (other.getCreatedBy() != null && other.getCreatedBy().equals(this.getCreatedBy()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
if (other.getLastModifiedBy() == null ^ this.getLastModifiedBy() == null)
return false;
if (other.getLastModifiedBy() != null && other.getLastModifiedBy().equals(this.getLastModifiedBy()) == false)
return false;
if (other.getMetadataProperties() == null ^ this.getMetadataProperties() == null)
return false;
if (other.getMetadataProperties() != null && other.getMetadataProperties().equals(this.getMetadataProperties()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getTrialComponentSummaries() == null ^ this.getTrialComponentSummaries() == null)
return false;
if (other.getTrialComponentSummaries() != null && other.getTrialComponentSummaries().equals(this.getTrialComponentSummaries()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTrialName() == null) ? 0 : getTrialName().hashCode());
hashCode = prime * hashCode + ((getTrialArn() == null) ? 0 : getTrialArn().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getExperimentName() == null) ? 0 : getExperimentName().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getLastModifiedBy() == null) ? 0 : getLastModifiedBy().hashCode());
hashCode = prime * hashCode + ((getMetadataProperties() == null) ? 0 : getMetadataProperties().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getTrialComponentSummaries() == null) ? 0 : getTrialComponentSummaries().hashCode());
return hashCode;
}
@Override
public Trial clone() {
try {
return (Trial) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.TrialMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy