AutoMLCandidate (AWS Java SDK for Amazon SageMaker 1.12.787 API)

java.lang.Object
- com.amazonaws.services.sagemaker.model.AutoMLCandidate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AutoMLCandidate
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AutoMLCandidate()

Constructors
Constructor and Description
`AutoMLCandidate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoMLCandidate`	`addInferenceContainerDefinitionsEntry(String key, List<AutoMLContainerDefinition> value)` Add a single InferenceContainerDefinitions entry
`AutoMLCandidate`	`clearInferenceContainerDefinitionsEntries()` Removes all the entries added into InferenceContainerDefinitions.
`AutoMLCandidate`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCandidateName()` The name of the candidate.
`CandidateProperties`	`getCandidateProperties()` The properties of an AutoML candidate job.
`String`	`getCandidateStatus()` The candidate's status.
`List<AutoMLCandidateStep>`	`getCandidateSteps()` Information about the candidate's steps.
`Date`	`getCreationTime()` The creation time.
`Date`	`getEndTime()` The end time.
`String`	`getFailureReason()` The failure reason.
`FinalAutoMLJobObjectiveMetric`	`getFinalAutoMLJobObjectiveMetric()`
`Map<String,List<AutoMLContainerDefinition>>`	`getInferenceContainerDefinitions()` The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.
`List<AutoMLContainerDefinition>`	`getInferenceContainers()` Information about the recommended inference container definitions.
`Date`	`getLastModifiedTime()` The last modified time.
`String`	`getObjectiveStatus()` The objective's status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCandidateName(String candidateName)` The name of the candidate.
`void`	`setCandidateProperties(CandidateProperties candidateProperties)` The properties of an AutoML candidate job.
`void`	`setCandidateStatus(String candidateStatus)` The candidate's status.
`void`	`setCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)` Information about the candidate's steps.
`void`	`setCreationTime(Date creationTime)` The creation time.
`void`	`setEndTime(Date endTime)` The end time.
`void`	`setFailureReason(String failureReason)` The failure reason.
`void`	`setFinalAutoMLJobObjectiveMetric(FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric)`
`void`	`setInferenceContainerDefinitions(Map<String,List<AutoMLContainerDefinition>> inferenceContainerDefinitions)` The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.
`void`	`setInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)` Information about the recommended inference container definitions.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The last modified time.
`void`	`setObjectiveStatus(String objectiveStatus)` The objective's status.
`String`	`toString()` Returns a string representation of this object.
`AutoMLCandidate`	`withCandidateName(String candidateName)` The name of the candidate.
`AutoMLCandidate`	`withCandidateProperties(CandidateProperties candidateProperties)` The properties of an AutoML candidate job.
`AutoMLCandidate`	`withCandidateStatus(CandidateStatus candidateStatus)` The candidate's status.
`AutoMLCandidate`	`withCandidateStatus(String candidateStatus)` The candidate's status.
`AutoMLCandidate`	`withCandidateSteps(AutoMLCandidateStep... candidateSteps)` Information about the candidate's steps.
`AutoMLCandidate`	`withCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)` Information about the candidate's steps.
`AutoMLCandidate`	`withCreationTime(Date creationTime)` The creation time.
`AutoMLCandidate`	`withEndTime(Date endTime)` The end time.
`AutoMLCandidate`	`withFailureReason(String failureReason)` The failure reason.
`AutoMLCandidate`	`withFinalAutoMLJobObjectiveMetric(FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric)`
`AutoMLCandidate`	`withInferenceContainerDefinitions(Map<String,List<AutoMLContainerDefinition>> inferenceContainerDefinitions)` The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.
`AutoMLCandidate`	`withInferenceContainers(AutoMLContainerDefinition... inferenceContainers)` Information about the recommended inference container definitions.
`AutoMLCandidate`	`withInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)` Information about the recommended inference container definitions.
`AutoMLCandidate`	`withLastModifiedTime(Date lastModifiedTime)` The last modified time.
`AutoMLCandidate`	`withObjectiveStatus(ObjectiveStatus objectiveStatus)` The objective's status.
`AutoMLCandidate`	`withObjectiveStatus(String objectiveStatus)` The objective's status.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AutoMLCandidate
```
public AutoMLCandidate()
```
- Method Detail
  - setCandidateName
```
public void setCandidateName(String candidateName)
```
    The name of the candidate.
    
    Parameters:
    
    candidateName - The name of the candidate.
  - getCandidateName
```
public String getCandidateName()
```
    The name of the candidate.
    
    Returns:
    
    The name of the candidate.
  - withCandidateName
```
public AutoMLCandidate withCandidateName(String candidateName)
```
    The name of the candidate.
    
    Parameters:
    
    candidateName - The name of the candidate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFinalAutoMLJobObjectiveMetric
```
public void setFinalAutoMLJobObjectiveMetric(FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric)
```
    Parameters:
    
    finalAutoMLJobObjectiveMetric -
  - getFinalAutoMLJobObjectiveMetric
```
public FinalAutoMLJobObjectiveMetric getFinalAutoMLJobObjectiveMetric()
```
    Returns:
  - withFinalAutoMLJobObjectiveMetric
```
public AutoMLCandidate withFinalAutoMLJobObjectiveMetric(FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric)
```
    Parameters:
    
    finalAutoMLJobObjectiveMetric -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObjectiveStatus
```
public void setObjectiveStatus(String objectiveStatus)
```
    The objective's status.
    
    Parameters:
    
    objectiveStatus - The objective's status.
    
    See Also:
    
    ObjectiveStatus
  - getObjectiveStatus
```
public String getObjectiveStatus()
```
    The objective's status.
    
    Returns:
    
    The objective's status.
    
    See Also:
    
    ObjectiveStatus
  - withObjectiveStatus
```
public AutoMLCandidate withObjectiveStatus(String objectiveStatus)
```
    The objective's status.
    
    Parameters:
    
    objectiveStatus - The objective's status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectiveStatus
  - withObjectiveStatus
```
public AutoMLCandidate withObjectiveStatus(ObjectiveStatus objectiveStatus)
```
    The objective's status.
    
    Parameters:
    
    objectiveStatus - The objective's status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectiveStatus
  - getCandidateSteps
```
public List<AutoMLCandidateStep> getCandidateSteps()
```
    Information about the candidate's steps.
    
    Returns:
    
    Information about the candidate's steps.
  - setCandidateSteps
```
public void setCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)
```
    Information about the candidate's steps.
    
    Parameters:
    
    candidateSteps - Information about the candidate's steps.
  - withCandidateSteps
```
public AutoMLCandidate withCandidateSteps(AutoMLCandidateStep... candidateSteps)
```
    Information about the candidate's steps.
    
    NOTE: This method appends the values to the existing list (if any). Use setCandidateSteps(java.util.Collection) or withCandidateSteps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    candidateSteps - Information about the candidate's steps.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCandidateSteps
```
public AutoMLCandidate withCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)
```
    Information about the candidate's steps.
    
    Parameters:
    
    candidateSteps - Information about the candidate's steps.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCandidateStatus
```
public void setCandidateStatus(String candidateStatus)
```
    The candidate's status.
    
    Parameters:
    
    candidateStatus - The candidate's status.
    
    See Also:
    
    CandidateStatus
  - getCandidateStatus
```
public String getCandidateStatus()
```
    The candidate's status.
    
    Returns:
    
    The candidate's status.
    
    See Also:
    
    CandidateStatus
  - withCandidateStatus
```
public AutoMLCandidate withCandidateStatus(String candidateStatus)
```
    The candidate's status.
    
    Parameters:
    
    candidateStatus - The candidate's status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CandidateStatus
  - withCandidateStatus
```
public AutoMLCandidate withCandidateStatus(CandidateStatus candidateStatus)
```
    The candidate's status.
    
    Parameters:
    
    candidateStatus - The candidate's status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CandidateStatus
  - getInferenceContainers
```
public List<AutoMLContainerDefinition> getInferenceContainers()
```
    Information about the recommended inference container definitions.
    
    Returns:
    
    Information about the recommended inference container definitions.
  - setInferenceContainers
```
public void setInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)
```
    Information about the recommended inference container definitions.
    
    Parameters:
    
    inferenceContainers - Information about the recommended inference container definitions.
  - withInferenceContainers
```
public AutoMLCandidate withInferenceContainers(AutoMLContainerDefinition... inferenceContainers)
```
    Information about the recommended inference container definitions.
    
    NOTE: This method appends the values to the existing list (if any). Use setInferenceContainers(java.util.Collection) or withInferenceContainers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inferenceContainers - Information about the recommended inference container definitions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInferenceContainers
```
public AutoMLCandidate withInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)
```
    Information about the recommended inference container definitions.
    
    Parameters:
    
    inferenceContainers - Information about the recommended inference container definitions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The creation time.
    
    Parameters:
    
    creationTime - The creation time.
  - getCreationTime
```
public Date getCreationTime()
```
    The creation time.
    
    Returns:
    
    The creation time.
  - withCreationTime
```
public AutoMLCandidate withCreationTime(Date creationTime)
```
    The creation time.
    
    Parameters:
    
    creationTime - The creation time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The end time.
    
    Parameters:
    
    endTime - The end time.
  - getEndTime
```
public Date getEndTime()
```
    The end time.
    
    Returns:
    
    The end time.
  - withEndTime
```
public AutoMLCandidate withEndTime(Date endTime)
```
    The end time.
    
    Parameters:
    
    endTime - The end time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The last modified time.
    
    Parameters:
    
    lastModifiedTime - The last modified time.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The last modified time.
    
    Returns:
    
    The last modified time.
  - withLastModifiedTime
```
public AutoMLCandidate withLastModifiedTime(Date lastModifiedTime)
```
    The last modified time.
    
    Parameters:
    
    lastModifiedTime - The last modified time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    The failure reason.
    
    Parameters:
    
    failureReason - The failure reason.
  - getFailureReason
```
public String getFailureReason()
```
    The failure reason.
    
    Returns:
    
    The failure reason.
  - withFailureReason
```
public AutoMLCandidate withFailureReason(String failureReason)
```
    The failure reason.
    
    Parameters:
    
    failureReason - The failure reason.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCandidateProperties
```
public void setCandidateProperties(CandidateProperties candidateProperties)
```
    The properties of an AutoML candidate job.
    
    Parameters:
    
    candidateProperties - The properties of an AutoML candidate job.
  - getCandidateProperties
```
public CandidateProperties getCandidateProperties()
```
    The properties of an AutoML candidate job.
    
    Returns:
    
    The properties of an AutoML candidate job.
  - withCandidateProperties
```
public AutoMLCandidate withCandidateProperties(CandidateProperties candidateProperties)
```
    The properties of an AutoML candidate job.
    
    Parameters:
    
    candidateProperties - The properties of an AutoML candidate job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInferenceContainerDefinitions
```
public Map<String,List<AutoMLContainerDefinition>> getInferenceContainerDefinitions()
```
    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.
    
    Returns:
    
    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.
  - setInferenceContainerDefinitions
```
public void setInferenceContainerDefinitions(Map<String,List<AutoMLContainerDefinition>> inferenceContainerDefinitions)
```
    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.
    
    Parameters:
    
    inferenceContainerDefinitions - 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.
  - withInferenceContainerDefinitions
```
public AutoMLCandidate withInferenceContainerDefinitions(Map<String,List<AutoMLContainerDefinition>> inferenceContainerDefinitions)
```
    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.
    
    Parameters:
    
    inferenceContainerDefinitions - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addInferenceContainerDefinitionsEntry
```
public AutoMLCandidate addInferenceContainerDefinitionsEntry(String key,
                                                             List<AutoMLContainerDefinition> value)
```
    Add a single InferenceContainerDefinitions entry
    
    See Also:
    
    withInferenceContainerDefinitions(java.util.Map<java.lang.String, java.util.List<com.amazonaws.services.sagemaker.model.AutoMLContainerDefinition>>)
  - clearInferenceContainerDefinitionsEntries
```
public AutoMLCandidate clearInferenceContainerDefinitionsEntries()
```
    Removes all the entries added into InferenceContainerDefinitions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AutoMLCandidate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AutoMLCandidate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AutoMLCandidate

Method Detail

setCandidateName

getCandidateName

withCandidateName

setFinalAutoMLJobObjectiveMetric

getFinalAutoMLJobObjectiveMetric

withFinalAutoMLJobObjectiveMetric

setObjectiveStatus

getObjectiveStatus

withObjectiveStatus

withObjectiveStatus

getCandidateSteps

setCandidateSteps

withCandidateSteps

withCandidateSteps

setCandidateStatus

getCandidateStatus

withCandidateStatus

withCandidateStatus

getInferenceContainers

setInferenceContainers

withInferenceContainers

withInferenceContainers

setCreationTime

getCreationTime

withCreationTime

setEndTime

getEndTime

withEndTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setFailureReason

getFailureReason

withFailureReason

setCandidateProperties

getCandidateProperties

withCandidateProperties

getInferenceContainerDefinitions

setInferenceContainerDefinitions

withInferenceContainerDefinitions

addInferenceContainerDefinitionsEntry

clearInferenceContainerDefinitionsEntries

toString

equals

hashCode

clone

marshall