DescribeHyperParameterTuningJobResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
    - - software.amazon.awssdk.services.sagemaker.model.DescribeHyperParameterTuningJobResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeHyperParameterTuningJobResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeHyperParameterTuningJobResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeHyperParameterTuningJobResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HyperParameterTrainingJobSummary`	`bestTrainingJob()` A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
`static DescribeHyperParameterTuningJobResponse.Builder`	`builder()`
`Instant`	`creationTime()` The date and time that the tuning job started.
`boolean`	`equals(Object obj)`
`String`	`failureReason()` If the tuning job failed, the reason it failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`Instant`	`hyperParameterTuningEndTime()` The date and time that the tuning job ended.
`String`	`hyperParameterTuningJobArn()` The Amazon Resource Name (ARN) of the tuning job.
`HyperParameterTuningJobConfig`	`hyperParameterTuningJobConfig()` The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
`String`	`hyperParameterTuningJobName()` The name of the tuning job.
`HyperParameterTuningJobStatus`	`hyperParameterTuningJobStatus()` The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
`String`	`hyperParameterTuningJobStatusAsString()` The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
`Instant`	`lastModifiedTime()` The date and time that the status of the tuning job was modified.
`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.
`HyperParameterTrainingJobSummary`	`overallBestTrainingJob()` If the hyperparameter tuning job is an warm start tuning job with a `WarmStartType` of `IDENTICAL_DATA_AND_ALGORITHM`, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeHyperParameterTuningJobResponse.Builder>`	`serializableBuilderClass()`
`DescribeHyperParameterTuningJobResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`HyperParameterTrainingJobDefinition`	`trainingJobDefinition()` The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
`TrainingJobStatusCounters`	`trainingJobStatusCounters()` The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
`HyperParameterTuningJobWarmStartConfig`	`warmStartConfig()` The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hyperParameterTuningJobName
```
public String hyperParameterTuningJobName()
```
    The name of the tuning job.
    
    Returns:
    
    The name of the tuning job.
  - hyperParameterTuningJobArn
```
public String hyperParameterTuningJobArn()
```
    The Amazon Resource Name (ARN) of the tuning job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the tuning job.
  - hyperParameterTuningJobConfig
```
public HyperParameterTuningJobConfig hyperParameterTuningJobConfig()
```
    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
    
    Returns:
    
    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
  - trainingJobDefinition
```
public HyperParameterTrainingJobDefinition trainingJobDefinition()
```
    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.
  - hyperParameterTuningJobStatus
```
public HyperParameterTuningJobStatus hyperParameterTuningJobStatus()
```
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    If the service returns an enum value that is not available in the current SDK version, hyperParameterTuningJobStatus will return HyperParameterTuningJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hyperParameterTuningJobStatusAsString().
    
    Returns:
    
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - hyperParameterTuningJobStatusAsString
```
public String hyperParameterTuningJobStatusAsString()
```
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    If the service returns an enum value that is not available in the current SDK version, hyperParameterTuningJobStatus will return HyperParameterTuningJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hyperParameterTuningJobStatusAsString().
    
    Returns:
    
    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - creationTime
```
public Instant creationTime()
```
    The date and time that the tuning job started.
    
    Returns:
    
    The date and time that the tuning job started.
  - hyperParameterTuningEndTime
```
public Instant hyperParameterTuningEndTime()
```
    The date and time that the tuning job ended.
    
    Returns:
    
    The date and time that the tuning job ended.
  - lastModifiedTime
```
public Instant lastModifiedTime()
```
    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.
  - trainingJobStatusCounters
```
public TrainingJobStatusCounters trainingJobStatusCounters()
```
    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.
  - objectiveStatusCounters
```
public 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.
    
    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.
  - bestTrainingJob
```
public HyperParameterTrainingJobSummary bestTrainingJob()
```
    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.
  - overallBestTrainingJob
```
public HyperParameterTrainingJobSummary overallBestTrainingJob()
```
    If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
    
    Returns:
    
    If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
  - warmStartConfig
```
public HyperParameterTuningJobWarmStartConfig warmStartConfig()
```
    The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
    
    Returns:
    
    The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
  - failureReason
```
public String failureReason()
```
    If the tuning job failed, the reason it failed.
    
    Returns:
    
    If the tuning job failed, the reason it failed.
  - toBuilder
```
public DescribeHyperParameterTuningJobResponse.Builder 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 interface ToCopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeHyperParameterTuningJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeHyperParameterTuningJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DescribeHyperParameterTuningJobResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hyperParameterTuningJobName

hyperParameterTuningJobArn

hyperParameterTuningJobConfig

trainingJobDefinition

hyperParameterTuningJobStatus

hyperParameterTuningJobStatusAsString

creationTime

hyperParameterTuningEndTime

lastModifiedTime

trainingJobStatusCounters

objectiveStatusCounters

bestTrainingJob

overallBestTrainingJob

warmStartConfig

failureReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields