AutoMLCandidate (AWS Java SDK :: Services :: Amazon SageMaker 2.13.59 API)

java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.AutoMLCandidate

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoMLCandidate.Builder,AutoMLCandidate>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AutoMLCandidate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutoMLCandidate.Builder,AutoMLCandidate>
```
An AutoPilot job will return recommendations, or candidates. Each candidate has futher details about the steps involed, and the status.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AutoMLCandidate.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AutoMLCandidate.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AutoMLCandidate.Builder`	`builder()`
`String`	`candidateName()` The candidate name.
`CandidateStatus`	`candidateStatus()` The candidate's status.
`String`	`candidateStatusAsString()` The candidate's status.
`List<AutoMLCandidateStep>`	`candidateSteps()` The candidate's steps.
`Instant`	`creationTime()` The creation time.
`Instant`	`endTime()` The end time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` The failure reason.
`FinalAutoMLJobObjectiveMetric`	`finalAutoMLJobObjectiveMetric()` Returns the value of the FinalAutoMLJobObjectiveMetric property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCandidateSteps()` Returns true if the CandidateSteps property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasInferenceContainers()` Returns true if the InferenceContainers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<AutoMLContainerDefinition>`	`inferenceContainers()` The inference containers.
`Instant`	`lastModifiedTime()` The last modified time.
`ObjectiveStatus`	`objectiveStatus()` The objective status.
`String`	`objectiveStatusAsString()` The objective status.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutoMLCandidate.Builder>`	`serializableBuilderClass()`
`AutoMLCandidate.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - candidateName
```
public String candidateName()
```
    The candidate name.
    
    Returns:
    
    The candidate name.
  - finalAutoMLJobObjectiveMetric
```
public FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric()
```
    Returns the value of the FinalAutoMLJobObjectiveMetric property for this object.
    
    Returns:
    
    The value of the FinalAutoMLJobObjectiveMetric property for this object.
  - objectiveStatus
```
public ObjectiveStatus objectiveStatus()
```
    The objective status.
    
    If the service returns an enum value that is not available in the current SDK version, objectiveStatus will return ObjectiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectiveStatusAsString().
    
    Returns:
    
    The objective status.
    
    See Also:
    
    ObjectiveStatus
  - objectiveStatusAsString
```
public String objectiveStatusAsString()
```
    The objective status.
    
    If the service returns an enum value that is not available in the current SDK version, objectiveStatus will return ObjectiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectiveStatusAsString().
    
    Returns:
    
    The objective status.
    
    See Also:
    
    ObjectiveStatus
  - hasCandidateSteps
```
public boolean hasCandidateSteps()
```
    Returns true if the CandidateSteps property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - candidateSteps
```
public List<AutoMLCandidateStep> candidateSteps()
```
    The candidate's steps.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCandidateSteps() to see if a value was sent in this field.
    
    Returns:
    
    The candidate's steps.
  - candidateStatus
```
public CandidateStatus candidateStatus()
```
    The candidate's status.
    
    If the service returns an enum value that is not available in the current SDK version, candidateStatus will return CandidateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from candidateStatusAsString().
    
    Returns:
    
    The candidate's status.
    
    See Also:
    
    CandidateStatus
  - candidateStatusAsString
```
public String candidateStatusAsString()
```
    The candidate's status.
    
    If the service returns an enum value that is not available in the current SDK version, candidateStatus will return CandidateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from candidateStatusAsString().
    
    Returns:
    
    The candidate's status.
    
    See Also:
    
    CandidateStatus
  - hasInferenceContainers
```
public boolean hasInferenceContainers()
```
    Returns true if the InferenceContainers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - inferenceContainers
```
public List<AutoMLContainerDefinition> inferenceContainers()
```
    The inference containers.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInferenceContainers() to see if a value was sent in this field.
    
    Returns:
    
    The inference containers.
  - creationTime
```
public Instant creationTime()
```
    The creation time.
    
    Returns:
    
    The creation time.
  - endTime
```
public Instant endTime()
```
    The end time.
    
    Returns:
    
    The end time.
  - lastModifiedTime
```
public Instant lastModifiedTime()
```
    The last modified time.
    
    Returns:
    
    The last modified time.
  - failureReason
```
public String failureReason()
```
    The failure reason.
    
    Returns:
    
    The failure reason.
  - toBuilder
```
public AutoMLCandidate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutoMLCandidate.Builder,AutoMLCandidate>
  - builder
```
public static AutoMLCandidate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutoMLCandidate.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AutoMLCandidate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

candidateName

finalAutoMLJobObjectiveMetric

objectiveStatus

objectiveStatusAsString

hasCandidateSteps

candidateSteps

candidateStatus

candidateStatusAsString

hasInferenceContainers

inferenceContainers

creationTime

endTime

lastModifiedTime

failureReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields