AutoMLCandidate (AWS SDK for Java

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
```
An AutoPilot job will return recommendations, or candidates. Each candidate has futher details about the steps involed, and the status.

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`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCandidateName()` The candidate name.
`String`	`getCandidateStatus()` The candidate's status.
`List<AutoMLCandidateStep>`	`getCandidateSteps()` The candidate's steps.
`Date`	`getCreationTime()` The creation time.
`Date`	`getEndTime()` The end time.
`String`	`getFailureReason()` The failure reason.
`FinalAutoMLJobObjectiveMetric`	`getFinalAutoMLJobObjectiveMetric()`
`List<AutoMLContainerDefinition>`	`getInferenceContainers()` The inference containers.
`Date`	`getLastModifiedTime()` The last modified time.
`String`	`getObjectiveStatus()` The objective status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCandidateName(String candidateName)` The candidate name.
`void`	`setCandidateStatus(String candidateStatus)` The candidate's status.
`void`	`setCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)` 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`	`setInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)` The inference containers.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The last modified time.
`void`	`setObjectiveStatus(String objectiveStatus)` The objective status.
`String`	`toString()` Returns a string representation of this object.
`AutoMLCandidate`	`withCandidateName(String candidateName)` The candidate name.
`AutoMLCandidate`	`withCandidateStatus(CandidateStatus candidateStatus)` The candidate's status.
`AutoMLCandidate`	`withCandidateStatus(String candidateStatus)` The candidate's status.
`AutoMLCandidate`	`withCandidateSteps(AutoMLCandidateStep... candidateSteps)` The candidate's steps.
`AutoMLCandidate`	`withCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)` 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`	`withInferenceContainers(AutoMLContainerDefinition... inferenceContainers)` The inference containers.
`AutoMLCandidate`	`withInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)` The inference containers.
`AutoMLCandidate`	`withLastModifiedTime(Date lastModifiedTime)` The last modified time.
`AutoMLCandidate`	`withObjectiveStatus(ObjectiveStatus objectiveStatus)` The objective status.
`AutoMLCandidate`	`withObjectiveStatus(String objectiveStatus)` The objective status.

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

- Constructor Detail
  - AutoMLCandidate
```
public AutoMLCandidate()
```
- Method Detail
  - setCandidateName
```
public void setCandidateName(String candidateName)
```
    The candidate name.
    
    Parameters:
    
    candidateName - The candidate name.
  - getCandidateName
```
public String getCandidateName()
```
    The candidate name.
    
    Returns:
    
    The candidate name.
  - withCandidateName
```
public AutoMLCandidate withCandidateName(String candidateName)
```
    The candidate name.
    
    Parameters:
    
    candidateName - The candidate name.
    
    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 status.
    
    Parameters:
    
    objectiveStatus - The objective status.
    
    See Also:
    
    ObjectiveStatus
  - getObjectiveStatus
```
public String getObjectiveStatus()
```
    The objective status.
    
    Returns:
    
    The objective status.
    
    See Also:
    
    ObjectiveStatus
  - withObjectiveStatus
```
public AutoMLCandidate withObjectiveStatus(String objectiveStatus)
```
    The objective status.
    
    Parameters:
    
    objectiveStatus - The objective 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 status.
    
    Parameters:
    
    objectiveStatus - The objective status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectiveStatus
  - getCandidateSteps
```
public List<AutoMLCandidateStep> getCandidateSteps()
```
    The candidate's steps.
    
    Returns:
    
    The candidate's steps.
  - setCandidateSteps
```
public void setCandidateSteps(Collection<AutoMLCandidateStep> candidateSteps)
```
    The candidate's steps.
    
    Parameters:
    
    candidateSteps - The candidate's steps.
  - withCandidateSteps
```
public AutoMLCandidate withCandidateSteps(AutoMLCandidateStep... candidateSteps)
```
    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 - 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)
```
    The candidate's steps.
    
    Parameters:
    
    candidateSteps - 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()
```
    The inference containers.
    
    Returns:
    
    The inference containers.
  - setInferenceContainers
```
public void setInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)
```
    The inference containers.
    
    Parameters:
    
    inferenceContainers - The inference containers.
  - withInferenceContainers
```
public AutoMLCandidate withInferenceContainers(AutoMLContainerDefinition... inferenceContainers)
```
    The inference containers.
    
    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 - The inference containers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInferenceContainers
```
public AutoMLCandidate withInferenceContainers(Collection<AutoMLContainerDefinition> inferenceContainers)
```
    The inference containers.
    
    Parameters:
    
    inferenceContainers - The inference containers.
    
    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.
  - 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)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

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

toString

equals

hashCode

clone

marshall