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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoMLCandidate.Builder,AutoMLCandidate>
```
@Generated("software.amazon.awssdk:codegen")
public final class AutoMLCandidate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutoMLCandidate.Builder,AutoMLCandidate>
```
Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AutoMLCandidate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AutoMLCandidate.Builder`	`builder()`
`String`	`candidateName()`	The name of the candidate.
`CandidateProperties`	`candidateProperties()`	The properties of an AutoML candidate job.
`CandidateStatus`	`candidateStatus()`	The candidate's status.
`String`	`candidateStatusAsString()`	The candidate's status.
`List<AutoMLCandidateStep>`	`candidateSteps()`	Information about 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()`	For responses, this returns true if the service returned a value for the CandidateSteps property.
`int`	`hashCode()`
`boolean`	`hasInferenceContainerDefinitions()`	For responses, this returns true if the service returned a value for the InferenceContainerDefinitions property.
`boolean`	`hasInferenceContainers()`	For responses, this returns true if the service returned a value for the InferenceContainers property.
`Map<AutoMLProcessingUnit,List<AutoMLContainerDefinition>>`	`inferenceContainerDefinitions()`	The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.
`Map<String,List<AutoMLContainerDefinition>>`	`inferenceContainerDefinitionsAsStrings()`	The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.
`List<AutoMLContainerDefinition>`	`inferenceContainers()`	Information about the recommended inference container definitions.
`Instant`	`lastModifiedTime()`	The last modified time.
`ObjectiveStatus`	`objectiveStatus()`	The objective's status.
`String`	`objectiveStatusAsString()`	The objective's status.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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 final String candidateName()
```
    The name of the candidate.
    
    Returns:
    
    The name of the candidate.
  - finalAutoMLJobObjectiveMetric
```
public final FinalAutoMLJobObjectiveMetric finalAutoMLJobObjectiveMetric()
```
    Returns the value of the FinalAutoMLJobObjectiveMetric property for this object.
    
    Returns:
    
    The value of the FinalAutoMLJobObjectiveMetric property for this object.
  - objectiveStatus
```
public final ObjectiveStatus objectiveStatus()
```
    The objective's 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's status.
    
    See Also:
    
    ObjectiveStatus
  - objectiveStatusAsString
```
public final String objectiveStatusAsString()
```
    The objective's 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's status.
    
    See Also:
    
    ObjectiveStatus
  - hasCandidateSteps
```
public final boolean hasCandidateSteps()
```
    For responses, this returns true if the service returned a value for the CandidateSteps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - candidateSteps
```
public final List<AutoMLCandidateStep> candidateSteps()
```
    Information about the candidate's steps.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCandidateSteps() method.
    
    Returns:
    
    Information about the candidate's steps.
  - candidateStatus
```
public final 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 final 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 final boolean hasInferenceContainers()
```
    For responses, this returns true if the service returned a value for the InferenceContainers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - inferenceContainers
```
public final List<AutoMLContainerDefinition> inferenceContainers()
```
    Information about the recommended inference container definitions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInferenceContainers() method.
    
    Returns:
    
    Information about the recommended inference container definitions.
  - creationTime
```
public final Instant creationTime()
```
    The creation time.
    
    Returns:
    
    The creation time.
  - endTime
```
public final Instant endTime()
```
    The end time.
    
    Returns:
    
    The end time.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The last modified time.
    
    Returns:
    
    The last modified time.
  - failureReason
```
public final String failureReason()
```
    The failure reason.
    
    Returns:
    
    The failure reason.
  - candidateProperties
```
public final CandidateProperties candidateProperties()
```
    The properties of an AutoML candidate job.
    
    Returns:
    
    The properties of an AutoML candidate job.
  - inferenceContainerDefinitions
```
public final Map<AutoMLProcessingUnit,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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInferenceContainerDefinitions() method.
    
    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.
  - hasInferenceContainerDefinitions
```
public final boolean hasInferenceContainerDefinitions()
```
    For responses, this returns true if the service returned a value for the InferenceContainerDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - inferenceContainerDefinitionsAsStrings
```
public final Map<String,List<AutoMLContainerDefinition>> inferenceContainerDefinitionsAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInferenceContainerDefinitions() method.
    
    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.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField 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

candidateProperties

inferenceContainerDefinitions

hasInferenceContainerDefinitions

inferenceContainerDefinitionsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField