FinalAutoMLJobObjectiveMetric (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class FinalAutoMLJobObjectiveMetric

java.lang.Object
- com.amazonaws.services.sagemaker.model.FinalAutoMLJobObjectiveMetric

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The best candidate result from an AutoML training job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FinalAutoMLJobObjectiveMetric ()

Constructors
Constructor and Description
`FinalAutoMLJobObjectiveMetric ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`FinalAutoMLJobObjectiveMetric`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getMetricName ()` The name of the metric with the best result.
`String`	`getStandardMetricName ()` The name of the standard metric.
`String`	`getType ()` The type of metric with the best result.
`Float`	`getValue ()` The value of the metric with the best result.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMetricName (String metricName)` The name of the metric with the best result.
`void`	`setStandardMetricName (String standardMetricName)` The name of the standard metric.
`void`	`setType (String type)` The type of metric with the best result.
`void`	`setValue (Float value)` The value of the metric with the best result.
`String`	`toString ()` Returns a string representation of this object.
`FinalAutoMLJobObjectiveMetric`	`withMetricName (AutoMLMetricEnum metricName)` The name of the metric with the best result.
`FinalAutoMLJobObjectiveMetric`	`withMetricName (String metricName)` The name of the metric with the best result.
`FinalAutoMLJobObjectiveMetric`	`withStandardMetricName (AutoMLMetricEnum standardMetricName)` The name of the standard metric.
`FinalAutoMLJobObjectiveMetric`	`withStandardMetricName (String standardMetricName)` The name of the standard metric.
`FinalAutoMLJobObjectiveMetric`	`withType (AutoMLJobObjectiveType type)` The type of metric with the best result.
`FinalAutoMLJobObjectiveMetric`	`withType (String type)` The type of metric with the best result.
`FinalAutoMLJobObjectiveMetric`	`withValue (Float value)` The value of the metric with the best result.

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

- Constructor Detail
  - FinalAutoMLJobObjectiveMetric
```
public FinalAutoMLJobObjectiveMetric()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of metric with the best result.
    
    Parameters:
    
    type - The type of metric with the best result.
    
    See Also:
    
    AutoMLJobObjectiveType
  - getType
```
public String getType()
```
    The type of metric with the best result.
    
    Returns:
    
    The type of metric with the best result.
    
    See Also:
    
    AutoMLJobObjectiveType
  - withType
```
public FinalAutoMLJobObjectiveMetric withType(String type)
```
    The type of metric with the best result.
    
    Parameters:
    
    type - The type of metric with the best result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoMLJobObjectiveType
  - withType
```
public FinalAutoMLJobObjectiveMetric withType(AutoMLJobObjectiveType type)
```
    The type of metric with the best result.
    
    Parameters:
    
    type - The type of metric with the best result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoMLJobObjectiveType
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    Parameters:
    
    metricName - The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    See Also:
    
    AutoMLMetricEnum
  - getMetricName
```
public String getMetricName()
```
    The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    Returns:
    
    The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    See Also:
    
    AutoMLMetricEnum
  - withMetricName
```
public FinalAutoMLJobObjectiveMetric withMetricName(String metricName)
```
    The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    Parameters:
    
    metricName - The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoMLMetricEnum
  - withMetricName
```
public FinalAutoMLJobObjectiveMetric withMetricName(AutoMLMetricEnum metricName)
```
    The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    Parameters:
    
    metricName - The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoMLMetricEnum
  - setValue
```
public void setValue(Float value)
```
    The value of the metric with the best result.
    
    Parameters:
    
    value - The value of the metric with the best result.
  - getValue
```
public Float getValue()
```
    The value of the metric with the best result.
    
    Returns:
    
    The value of the metric with the best result.
  - withValue
```
public FinalAutoMLJobObjectiveMetric withValue(Float value)
```
    The value of the metric with the best result.
    
    Parameters:
    
    value - The value of the metric with the best result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStandardMetricName
```
public void setStandardMetricName(String standardMetricName)
```
    The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    Parameters:
    
    standardMetricName - The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    See Also:
    
    AutoMLMetricEnum
  - getStandardMetricName
```
public String getStandardMetricName()
```
    The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    Returns:
    
    The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    See Also:
    
    AutoMLMetricEnum
  - withStandardMetricName
```
public FinalAutoMLJobObjectiveMetric withStandardMetricName(String standardMetricName)
```
    The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    Parameters:
    
    standardMetricName - The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoMLMetricEnum
  - withStandardMetricName
```
public FinalAutoMLJobObjectiveMetric withStandardMetricName(AutoMLMetricEnum standardMetricName)
```
    The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    Parameters:
    
    standardMetricName - The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoMLMetricEnum
  - 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 FinalAutoMLJobObjectiveMetric 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class FinalAutoMLJobObjectiveMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FinalAutoMLJobObjectiveMetric

Method Detail

setType

getType

withType

withType

setMetricName

getMetricName

withMetricName

withMetricName

setValue

getValue

withValue

setStandardMetricName

getStandardMetricName

withStandardMetricName

withStandardMetricName

toString

equals

hashCode

clone

marshall