DescribeHyperParameterTuningJobResponse (AWS Java SDK :: Services

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)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If the tuning job failed, the reason it failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTrainingJobDefinitions()` For responses, this returns true if the service returned a value for the TrainingJobDefinitions property.
`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()`
`String`	`toString()` Returns a string representation of this object.
`HyperParameterTrainingJobDefinition`	`trainingJobDefinition()` The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
`List<HyperParameterTrainingJobDefinition>`	`trainingJobDefinitions()` A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - hyperParameterTuningJobName
```
public final String hyperParameterTuningJobName()
```
    The name of the tuning job.
    
    Returns:
    
    The name of the tuning job.
  - hyperParameterTuningJobArn
```
public final String hyperParameterTuningJobArn()
```
    The Amazon Resource Name (ARN) of the tuning job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the tuning job.
  - hyperParameterTuningJobConfig
```
public final 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 final 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.
  - hasTrainingJobDefinitions
```
public final boolean hasTrainingJobDefinitions()
```
    For responses, this returns true if the service returned a value for the TrainingJobDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - trainingJobDefinitions
```
public final List<HyperParameterTrainingJobDefinition> trainingJobDefinitions()
```
    A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
    
    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 hasTrainingJobDefinitions() method.
    
    Returns:
    
    A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
  - hyperParameterTuningJobStatus
```
public final 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 final 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 final Instant creationTime()
```
    The date and time that the tuning job started.
    
    Returns:
    
    The date and time that the tuning job started.
  - hyperParameterTuningEndTime
```
public final Instant hyperParameterTuningEndTime()
```
    The date and time that the tuning job ended.
    
    Returns:
    
    The date and time that the tuning job ended.
  - lastModifiedTime
```
public final 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 final 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 final 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 final 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 final 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 final 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 final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeHyperParameterTuningJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeHyperParameterTuningJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasTrainingJobDefinitions

trainingJobDefinitions

hyperParameterTuningJobStatus

hyperParameterTuningJobStatusAsString

creationTime

hyperParameterTuningEndTime

lastModifiedTime

trainingJobStatusCounters

objectiveStatusCounters

bestTrainingJob

overallBestTrainingJob

warmStartConfig

failureReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields