Class AutoMLCandidate
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AutoMLCandidate.Builder,
AutoMLCandidate>
Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AutoMLCandidate.Builder
builder()
final String
The name of the candidate.final CandidateProperties
The properties of an AutoML candidate job.final CandidateStatus
The candidate's status.final String
The candidate's status.final List
<AutoMLCandidateStep> Information about the candidate's steps.final Instant
The creation time.final Instant
endTime()
The end time.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The failure reason.Returns the value of the FinalAutoMLJobObjectiveMetric property for this object.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CandidateSteps property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InferenceContainerDefinitions property.final boolean
For responses, this returns true if the service returned a value for the InferenceContainers property.The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.final Map
<String, List<AutoMLContainerDefinition>> The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate.final List
<AutoMLContainerDefinition> Information about the recommended inference container definitions.final Instant
The last modified time.final ObjectiveStatus
The objective's status.final String
The objective's status.static Class
<? extends AutoMLCandidate.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
candidateName
The name of the candidate.
- Returns:
- The name of the candidate.
-
finalAutoMLJobObjectiveMetric
Returns the value of the FinalAutoMLJobObjectiveMetric property for this object.- Returns:
- The value of the FinalAutoMLJobObjectiveMetric property for this object.
-
objectiveStatus
The objective's status.
If the service returns an enum value that is not available in the current SDK version,
objectiveStatus
will returnObjectiveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectiveStatusAsString()
.- Returns:
- The objective's status.
- See Also:
-
objectiveStatusAsString
The objective's status.
If the service returns an enum value that is not available in the current SDK version,
objectiveStatus
will returnObjectiveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectiveStatusAsString()
.- Returns:
- The objective's status.
- See Also:
-
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 theisEmpty()
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
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
The candidate's status.
If the service returns an enum value that is not available in the current SDK version,
candidateStatus
will returnCandidateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcandidateStatusAsString()
.- Returns:
- The candidate's status.
- See Also:
-
candidateStatusAsString
The candidate's status.
If the service returns an enum value that is not available in the current SDK version,
candidateStatus
will returnCandidateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcandidateStatusAsString()
.- Returns:
- The candidate's status.
- See Also:
-
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 theisEmpty()
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
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
The creation time.
- Returns:
- The creation time.
-
endTime
The end time.
- Returns:
- The end time.
-
lastModifiedTime
The last modified time.
- Returns:
- The last modified time.
-
failureReason
The failure reason.
- Returns:
- The failure reason.
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AutoMLCandidate.Builder,
AutoMLCandidate> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-