DescribeHyperParameterTuningJobResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.sagemaker.model.DescribeHyperParameterTuningJobResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeHyperParameterTuningJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeHyperParameterTuningJobResult()

Constructors
Constructor and Description
`DescribeHyperParameterTuningJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeHyperParameterTuningJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`HyperParameterTrainingJobSummary`	`getBestTrainingJob()` A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
`Date`	`getCreationTime()` The date and time that the tuning job started.
`String`	`getFailureReason()` If the tuning job failed, the reason it failed.
`Date`	`getHyperParameterTuningEndTime()` The date and time that the tuning job ended.
`String`	`getHyperParameterTuningJobArn()` The Amazon Resource Name (ARN) of the tuning job.
`HyperParameterTuningJobConfig`	`getHyperParameterTuningJobConfig()` The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
`String`	`getHyperParameterTuningJobName()` The name of the tuning job.
`String`	`getHyperParameterTuningJobStatus()` The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
`Date`	`getLastModifiedTime()` The date and time that the status of the tuning job was modified.
`ObjectiveStatusCounters`	`getObjectiveStatusCounters()` The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
`HyperParameterTrainingJobDefinition`	`getTrainingJobDefinition()` The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
`TrainingJobStatusCounters`	`getTrainingJobStatusCounters()` The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
`int`	`hashCode()`
`void`	`setBestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)` A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
`void`	`setCreationTime(Date creationTime)` The date and time that the tuning job started.
`void`	`setFailureReason(String failureReason)` If the tuning job failed, the reason it failed.
`void`	`setHyperParameterTuningEndTime(Date hyperParameterTuningEndTime)` The date and time that the tuning job ended.
`void`	`setHyperParameterTuningJobArn(String hyperParameterTuningJobArn)` The Amazon Resource Name (ARN) of the tuning job.
`void`	`setHyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)` The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
`void`	`setHyperParameterTuningJobName(String hyperParameterTuningJobName)` The name of the tuning job.
`void`	`setHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)` The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The date and time that the status of the tuning job was modified.
`void`	`setObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)` The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
`void`	`setTrainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)` The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
`void`	`setTrainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)` The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeHyperParameterTuningJobResult`	`withBestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)` A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
`DescribeHyperParameterTuningJobResult`	`withCreationTime(Date creationTime)` The date and time that the tuning job started.
`DescribeHyperParameterTuningJobResult`	`withFailureReason(String failureReason)` If the tuning job failed, the reason it failed.
`DescribeHyperParameterTuningJobResult`	`withHyperParameterTuningEndTime(Date hyperParameterTuningEndTime)` The date and time that the tuning job ended.
`DescribeHyperParameterTuningJobResult`	`withHyperParameterTuningJobArn(String hyperParameterTuningJobArn)` The Amazon Resource Name (ARN) of the tuning job.
`DescribeHyperParameterTuningJobResult`	`withHyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)` The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
`DescribeHyperParameterTuningJobResult`	`withHyperParameterTuningJobName(String hyperParameterTuningJobName)` The name of the tuning job.
`DescribeHyperParameterTuningJobResult`	`withHyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)` The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
`DescribeHyperParameterTuningJobResult`	`withHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)` The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
`DescribeHyperParameterTuningJobResult`	`withLastModifiedTime(Date lastModifiedTime)` The date and time that the status of the tuning job was modified.
`DescribeHyperParameterTuningJobResult`	`withObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)` The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
`DescribeHyperParameterTuningJobResult`	`withTrainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)` The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
`DescribeHyperParameterTuningJobResult`	`withTrainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)` The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeHyperParameterTuningJobResult
```
public DescribeHyperParameterTuningJobResult()
```
- Method Detail
  - setHyperParameterTuningJobName
```
public void setHyperParameterTuningJobName(String hyperParameterTuningJobName)
```
    The name of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobName - The name of the tuning job.
  - getHyperParameterTuningJobName
```
public String getHyperParameterTuningJobName()
```
    The name of the tuning job.
    
    Returns:
    
    The name of the tuning job.
  - withHyperParameterTuningJobName
```
public DescribeHyperParameterTuningJobResult withHyperParameterTuningJobName(String hyperParameterTuningJobName)
```
    The name of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobName - The name of the tuning job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHyperParameterTuningJobArn
```
public void setHyperParameterTuningJobArn(String hyperParameterTuningJobArn)
```
    The Amazon Resource Name (ARN) of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobArn - The Amazon Resource Name (ARN) of the tuning job.
  - getHyperParameterTuningJobArn
```
public String getHyperParameterTuningJobArn()
```
    The Amazon Resource Name (ARN) of the tuning job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the tuning job.
  - withHyperParameterTuningJobArn
```
public DescribeHyperParameterTuningJobResult withHyperParameterTuningJobArn(String hyperParameterTuningJobArn)
```
    The Amazon Resource Name (ARN) of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobArn - The Amazon Resource Name (ARN) of the tuning job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHyperParameterTuningJobConfig
```
public void setHyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)
```
    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobConfig - The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
  - getHyperParameterTuningJobConfig
```
public HyperParameterTuningJobConfig getHyperParameterTuningJobConfig()
```
    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
    
    Returns:
    
    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
  - withHyperParameterTuningJobConfig
```
public DescribeHyperParameterTuningJobResult withHyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)
```
    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobConfig - The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingJobDefinition
```
public void setTrainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)
```
    The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
    
    Parameters:
    
    trainingJobDefinition - The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
  - getTrainingJobDefinition
```
public HyperParameterTrainingJobDefinition getTrainingJobDefinition()
```
    The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
    
    Returns:
    
    The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
  - withTrainingJobDefinition
```
public DescribeHyperParameterTuningJobResult withTrainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)
```
    The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
    
    Parameters:
    
    trainingJobDefinition - The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHyperParameterTuningJobStatus
```
public void setHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)
```
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    Parameters:
    
    hyperParameterTuningJobStatus - The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - getHyperParameterTuningJobStatus
```
public String getHyperParameterTuningJobStatus()
```
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    Returns:
    
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - withHyperParameterTuningJobStatus
```
public DescribeHyperParameterTuningJobResult withHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)
```
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    Parameters:
    
    hyperParameterTuningJobStatus - The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - withHyperParameterTuningJobStatus
```
public DescribeHyperParameterTuningJobResult withHyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)
```
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    Parameters:
    
    hyperParameterTuningJobStatus - The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time that the tuning job started.
    
    Parameters:
    
    creationTime - The date and time that the tuning job started.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time that the tuning job started.
    
    Returns:
    
    The date and time that the tuning job started.
  - withCreationTime
```
public DescribeHyperParameterTuningJobResult withCreationTime(Date creationTime)
```
    The date and time that the tuning job started.
    
    Parameters:
    
    creationTime - The date and time that the tuning job started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHyperParameterTuningEndTime
```
public void setHyperParameterTuningEndTime(Date hyperParameterTuningEndTime)
```
    The date and time that the tuning job ended.
    
    Parameters:
    
    hyperParameterTuningEndTime - The date and time that the tuning job ended.
  - getHyperParameterTuningEndTime
```
public Date getHyperParameterTuningEndTime()
```
    The date and time that the tuning job ended.
    
    Returns:
    
    The date and time that the tuning job ended.
  - withHyperParameterTuningEndTime
```
public DescribeHyperParameterTuningJobResult withHyperParameterTuningEndTime(Date hyperParameterTuningEndTime)
```
    The date and time that the tuning job ended.
    
    Parameters:
    
    hyperParameterTuningEndTime - The date and time that the tuning job ended.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The date and time that the status of the tuning job was modified.
    
    Parameters:
    
    lastModifiedTime - The date and time that the status of the tuning job was modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The date and time that the status of the tuning job was modified.
    
    Returns:
    
    The date and time that the status of the tuning job was modified.
  - withLastModifiedTime
```
public DescribeHyperParameterTuningJobResult withLastModifiedTime(Date lastModifiedTime)
```
    The date and time that the status of the tuning job was modified.
    
    Parameters:
    
    lastModifiedTime - The date and time that the status of the tuning job was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingJobStatusCounters
```
public void setTrainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)
```
    The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
    
    Parameters:
    
    trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
  - getTrainingJobStatusCounters
```
public TrainingJobStatusCounters getTrainingJobStatusCounters()
```
    The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
    
    Returns:
    
    The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
  - withTrainingJobStatusCounters
```
public DescribeHyperParameterTuningJobResult withTrainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)
```
    The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
    
    Parameters:
    
    trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObjectiveStatusCounters
```
public void setObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)
```
    The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
    
    Parameters:
    
    objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
  - getObjectiveStatusCounters
```
public ObjectiveStatusCounters getObjectiveStatusCounters()
```
    The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
    
    Returns:
    
    The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
  - withObjectiveStatusCounters
```
public DescribeHyperParameterTuningJobResult withObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)
```
    The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
    
    Parameters:
    
    objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBestTrainingJob
```
public void setBestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)
```
    A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
    
    Parameters:
    
    bestTrainingJob - A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
  - getBestTrainingJob
```
public HyperParameterTrainingJobSummary getBestTrainingJob()
```
    A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
    
    Returns:
    
    A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
  - withBestTrainingJob
```
public DescribeHyperParameterTuningJobResult withBestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)
```
    A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
    
    Parameters:
    
    bestTrainingJob - A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the tuning job failed, the reason it failed.
    
    Parameters:
    
    failureReason - If the tuning job failed, the reason it failed.
  - getFailureReason
```
public String getFailureReason()
```
    If the tuning job failed, the reason it failed.
    
    Returns:
    
    If the tuning job failed, the reason it failed.
  - withFailureReason
```
public DescribeHyperParameterTuningJobResult withFailureReason(String failureReason)
```
    If the tuning job failed, the reason it failed.
    
    Parameters:
    
    failureReason - If the tuning job failed, the reason it failed.
    
    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; useful for testing and debugging.
    
    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 DescribeHyperParameterTuningJobResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeHyperParameterTuningJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeHyperParameterTuningJobResult

Method Detail

setHyperParameterTuningJobName

getHyperParameterTuningJobName

withHyperParameterTuningJobName

setHyperParameterTuningJobArn

getHyperParameterTuningJobArn

withHyperParameterTuningJobArn

setHyperParameterTuningJobConfig

getHyperParameterTuningJobConfig

withHyperParameterTuningJobConfig

setTrainingJobDefinition

getTrainingJobDefinition

withTrainingJobDefinition

setHyperParameterTuningJobStatus

getHyperParameterTuningJobStatus

withHyperParameterTuningJobStatus

withHyperParameterTuningJobStatus

setCreationTime

getCreationTime

withCreationTime

setHyperParameterTuningEndTime

getHyperParameterTuningEndTime

withHyperParameterTuningEndTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setTrainingJobStatusCounters

getTrainingJobStatusCounters

withTrainingJobStatusCounters

setObjectiveStatusCounters

getObjectiveStatusCounters

withObjectiveStatusCounters

setBestTrainingJob

getBestTrainingJob

withBestTrainingJob

setFailureReason

getFailureReason

withFailureReason

toString

equals

hashCode

clone