com.amazonaws.services.sagemaker.model

Class CandidateProperties

java.lang.Object

com.amazonaws.services.sagemaker.model.CandidateProperties

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CandidateProperties
extends Object
implements Serializable, Cloneable, StructuredPojo

The properties of an AutoML candidate job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CandidateProperties()

Method Summary

Modifier and Type	Method and Description
CandidateProperties	clone()
boolean	equals(Object obj)
CandidateArtifactLocations	getCandidateArtifactLocations() The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
List<MetricDatum>	getCandidateMetrics() Information about the candidate metrics for an AutoML job.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCandidateArtifactLocations(CandidateArtifactLocations candidateArtifactLocations) The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
void	setCandidateMetrics(Collection<MetricDatum> candidateMetrics) Information about the candidate metrics for an AutoML job.
String	toString() Returns a string representation of this object.
CandidateProperties	withCandidateArtifactLocations(CandidateArtifactLocations candidateArtifactLocations) The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
CandidateProperties	withCandidateMetrics(Collection<MetricDatum> candidateMetrics) Information about the candidate metrics for an AutoML job.
CandidateProperties	withCandidateMetrics(MetricDatum... candidateMetrics) Information about the candidate metrics for an AutoML job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CandidateProperties

public CandidateProperties()

Method Detail

setCandidateArtifactLocations

public void setCandidateArtifactLocations(CandidateArtifactLocations candidateArtifactLocations)

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

Parameters:

candidateArtifactLocations - The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

getCandidateArtifactLocations

public CandidateArtifactLocations getCandidateArtifactLocations()

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

Returns:

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

withCandidateArtifactLocations

public CandidateProperties withCandidateArtifactLocations(CandidateArtifactLocations candidateArtifactLocations)

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

Parameters:

candidateArtifactLocations - The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCandidateMetrics

public List<MetricDatum> getCandidateMetrics()

Information about the candidate metrics for an AutoML job.

Returns:

Information about the candidate metrics for an AutoML job.

setCandidateMetrics

public void setCandidateMetrics(Collection<MetricDatum> candidateMetrics)

Information about the candidate metrics for an AutoML job.

Parameters:

candidateMetrics - Information about the candidate metrics for an AutoML job.

withCandidateMetrics

public CandidateProperties withCandidateMetrics(MetricDatum... candidateMetrics)

Information about the candidate metrics for an AutoML job.

NOTE: This method appends the values to the existing list (if any). Use setCandidateMetrics(java.util.Collection) or withCandidateMetrics(java.util.Collection) if you want to override the existing values.

Parameters:

candidateMetrics - Information about the candidate metrics for an AutoML job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCandidateMetrics

public CandidateProperties withCandidateMetrics(Collection<MetricDatum> candidateMetrics)

Information about the candidate metrics for an AutoML job.

Parameters:

candidateMetrics - Information about the candidate metrics for an AutoML job.

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 CandidateProperties 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.