/* * Copyright 2018-2023 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; /** *
* Information about a candidate produced by an AutoML training job, including its status, steps, and other properties. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AutoMLCandidate implements Serializable, Cloneable, StructuredPojo { /** ** The name of the candidate. *
*/ private String candidateName; private FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric; /** ** The objective's status. *
*/ private String objectiveStatus; /** ** Information about the candidate's steps. *
*/ private java.util.List* The candidate's status. *
*/ private String candidateStatus; /** ** Information about the recommended inference container definitions. *
*/ private java.util.List* The creation time. *
*/ private java.util.Date creationTime; /** ** The end time. *
*/ private java.util.Date endTime; /** ** The last modified time. *
*/ private java.util.Date lastModifiedTime; /** ** The failure reason. *
*/ private String failureReason; /** ** The properties of an AutoML candidate job. *
*/ private CandidateProperties candidateProperties; /** *
* The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the
* candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling
* CreateAutoMLJobV2
) related to image or text classification problem types only.
*
* The name of the candidate. *
* * @param candidateName * The name of the candidate. */ public void setCandidateName(String candidateName) { this.candidateName = candidateName; } /** ** The name of the candidate. *
* * @return The name of the candidate. */ public String getCandidateName() { return this.candidateName; } /** ** The name of the candidate. *
* * @param candidateName * The name of the candidate. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withCandidateName(String candidateName) { setCandidateName(candidateName); return this; } /** * @param finalAutoMLJobObjectiveMetric */ public void setFinalAutoMLJobObjectiveMetric(FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric) { this.finalAutoMLJobObjectiveMetric = finalAutoMLJobObjectiveMetric; } /** * @return */ public FinalAutoMLJobObjectiveMetric getFinalAutoMLJobObjectiveMetric() { return this.finalAutoMLJobObjectiveMetric; } /** * @param finalAutoMLJobObjectiveMetric * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withFinalAutoMLJobObjectiveMetric(FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric) { setFinalAutoMLJobObjectiveMetric(finalAutoMLJobObjectiveMetric); return this; } /** ** The objective's status. *
* * @param objectiveStatus * The objective's status. * @see ObjectiveStatus */ public void setObjectiveStatus(String objectiveStatus) { this.objectiveStatus = objectiveStatus; } /** ** The objective's status. *
* * @return The objective's status. * @see ObjectiveStatus */ public String getObjectiveStatus() { return this.objectiveStatus; } /** ** The objective's status. *
* * @param objectiveStatus * The objective's status. * @return Returns a reference to this object so that method calls can be chained together. * @see ObjectiveStatus */ public AutoMLCandidate withObjectiveStatus(String objectiveStatus) { setObjectiveStatus(objectiveStatus); return this; } /** ** The objective's status. *
* * @param objectiveStatus * The objective's status. * @return Returns a reference to this object so that method calls can be chained together. * @see ObjectiveStatus */ public AutoMLCandidate withObjectiveStatus(ObjectiveStatus objectiveStatus) { this.objectiveStatus = objectiveStatus.toString(); return this; } /** ** Information about the candidate's steps. *
* * @return Information about the candidate's steps. */ public java.util.List* Information about the candidate's steps. *
* * @param candidateSteps * Information about the candidate's steps. */ public void setCandidateSteps(java.util.Collection* Information about the candidate's steps. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setCandidateSteps(java.util.Collection)} or {@link #withCandidateSteps(java.util.Collection)} if you want * to override the existing values. *
* * @param candidateSteps * Information about the candidate's steps. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withCandidateSteps(AutoMLCandidateStep... candidateSteps) { if (this.candidateSteps == null) { setCandidateSteps(new java.util.ArrayList* Information about the candidate's steps. *
* * @param candidateSteps * Information about the candidate's steps. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withCandidateSteps(java.util.Collection* The candidate's status. *
* * @param candidateStatus * The candidate's status. * @see CandidateStatus */ public void setCandidateStatus(String candidateStatus) { this.candidateStatus = candidateStatus; } /** ** The candidate's status. *
* * @return The candidate's status. * @see CandidateStatus */ public String getCandidateStatus() { return this.candidateStatus; } /** ** The candidate's status. *
* * @param candidateStatus * The candidate's status. * @return Returns a reference to this object so that method calls can be chained together. * @see CandidateStatus */ public AutoMLCandidate withCandidateStatus(String candidateStatus) { setCandidateStatus(candidateStatus); return this; } /** ** The candidate's status. *
* * @param candidateStatus * The candidate's status. * @return Returns a reference to this object so that method calls can be chained together. * @see CandidateStatus */ public AutoMLCandidate withCandidateStatus(CandidateStatus candidateStatus) { this.candidateStatus = candidateStatus.toString(); return this; } /** ** Information about the recommended inference container definitions. *
* * @return Information about the recommended inference container definitions. */ public java.util.List* Information about the recommended inference container definitions. *
* * @param inferenceContainers * Information about the recommended inference container definitions. */ public void setInferenceContainers(java.util.Collection* Information about the recommended inference container definitions. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setInferenceContainers(java.util.Collection)} or {@link #withInferenceContainers(java.util.Collection)} * if you want to override the existing values. *
* * @param inferenceContainers * Information about the recommended inference container definitions. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withInferenceContainers(AutoMLContainerDefinition... inferenceContainers) { if (this.inferenceContainers == null) { setInferenceContainers(new java.util.ArrayList* Information about the recommended inference container definitions. *
* * @param inferenceContainers * Information about the recommended inference container definitions. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withInferenceContainers(java.util.Collection* The creation time. *
* * @param creationTime * The creation time. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** ** The creation time. *
* * @return The creation time. */ public java.util.Date getCreationTime() { return this.creationTime; } /** ** The creation time. *
* * @param creationTime * The creation time. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** ** The end time. *
* * @param endTime * The end time. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The end time. *
* * @return The end time. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The end time. *
* * @param endTime * The end time. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** ** The last modified time. *
* * @param lastModifiedTime * The last modified time. */ public void setLastModifiedTime(java.util.Date lastModifiedTime) { this.lastModifiedTime = lastModifiedTime; } /** ** The last modified time. *
* * @return The last modified time. */ public java.util.Date getLastModifiedTime() { return this.lastModifiedTime; } /** ** The last modified time. *
* * @param lastModifiedTime * The last modified time. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withLastModifiedTime(java.util.Date lastModifiedTime) { setLastModifiedTime(lastModifiedTime); return this; } /** ** The failure reason. *
* * @param failureReason * The failure reason. */ public void setFailureReason(String failureReason) { this.failureReason = failureReason; } /** ** The failure reason. *
* * @return The failure reason. */ public String getFailureReason() { return this.failureReason; } /** ** The failure reason. *
* * @param failureReason * The failure reason. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withFailureReason(String failureReason) { setFailureReason(failureReason); return this; } /** ** The properties of an AutoML candidate job. *
* * @param candidateProperties * The properties of an AutoML candidate job. */ public void setCandidateProperties(CandidateProperties candidateProperties) { this.candidateProperties = candidateProperties; } /** ** The properties of an AutoML candidate job. *
* * @return The properties of an AutoML candidate job. */ public CandidateProperties getCandidateProperties() { return this.candidateProperties; } /** ** The properties of an AutoML candidate job. *
* * @param candidateProperties * The properties of an AutoML candidate job. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLCandidate withCandidateProperties(CandidateProperties candidateProperties) { setCandidateProperties(candidateProperties); return this; } /** *
* The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the
* candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling
* CreateAutoMLJobV2
) related to image or text classification problem types only.
*
CreateAutoMLJobV2
) related to image or text classification problem types only.
*/
public java.util.Map
* The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the
* candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling
* CreateAutoMLJobV2
) related to image or text classification problem types only.
*
CreateAutoMLJobV2
) related to image or text classification problem types only.
*/
public void setInferenceContainerDefinitions(java.util.Map
* The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the
* candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling
* CreateAutoMLJobV2
) related to image or text classification problem types only.
*
CreateAutoMLJobV2
) related to image or text classification problem types only.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutoMLCandidate withInferenceContainerDefinitions(java.util.Map