HyperParameterTuningJobSummary (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.HyperParameterTuningJobSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<HyperParameterTuningJobSummary.Builder,HyperParameterTuningJobSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class HyperParameterTuningJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterTuningJobSummary.Builder,HyperParameterTuningJobSummary>

Provides summary information about a hyperparameter tuning job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HyperParameterTuningJobSummary.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HyperParameterTuningJobSummary.Builder`	`builder()`
`Instant`	`creationTime()` The date and time that the tuning job was created.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`hyperParameterTuningEndTime()` The date and time that the tuning job ended.
`String`	`hyperParameterTuningJobArn()` The Amazon Resource Name (ARN) of the tuning job.
`String`	`hyperParameterTuningJobName()` The name of the tuning job.
`HyperParameterTuningJobStatus`	`hyperParameterTuningJobStatus()` The status of the tuning job.
`String`	`hyperParameterTuningJobStatusAsString()` The status of the tuning job.
`Instant`	`lastModifiedTime()` The date and time that the tuning job was modified.
`ObjectiveStatusCounters`	`objectiveStatusCounters()` The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
`ResourceLimits`	`resourceLimits()` The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HyperParameterTuningJobSummary.Builder>`	`serializableBuilderClass()`
`HyperParameterTuningJobStrategyType`	`strategy()` Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration.
`String`	`strategyAsString()` Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration.
`HyperParameterTuningJobSummary.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`TrainingJobStatusCounters`	`trainingJobStatusCounters()` The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

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.
  - hyperParameterTuningJobStatus
```
public HyperParameterTuningJobStatus hyperParameterTuningJobStatus()
```
    The status of the tuning job.
    
    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.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - hyperParameterTuningJobStatusAsString
```
public String hyperParameterTuningJobStatusAsString()
```
    The status of the tuning job.
    
    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.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - strategy
```
public HyperParameterTuningJobStrategyType strategy()
```
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    If the service returns an enum value that is not available in the current SDK version, strategy will return HyperParameterTuningJobStrategyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from strategyAsString().
    
    Returns:
    
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    See Also:
    
    HyperParameterTuningJobStrategyType
  - strategyAsString
```
public String strategyAsString()
```
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    If the service returns an enum value that is not available in the current SDK version, strategy will return HyperParameterTuningJobStrategyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from strategyAsString().
    
    Returns:
    
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    See Also:
    
    HyperParameterTuningJobStrategyType
  - creationTime
```
public Instant creationTime()
```
    The date and time that the tuning job was created.
    
    Returns:
    
    The date and time that the tuning job was created.
  - 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 tuning job was modified.
    
    Returns:
    
    The date and time that the tuning job was modified.
  - trainingJobStatusCounters
```
public TrainingJobStatusCounters trainingJobStatusCounters()
```
    The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
    
    Returns:
    
    The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
  - objectiveStatusCounters
```
public ObjectiveStatusCounters objectiveStatusCounters()
```
    The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
    
    Returns:
    
    The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
  - resourceLimits
```
public ResourceLimits resourceLimits()
```
    The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
    
    Returns:
    
    The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
  - toBuilder
```
public HyperParameterTuningJobSummary.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<HyperParameterTuningJobSummary.Builder,HyperParameterTuningJobSummary>
    
    Returns:
    
    a builder for type T
  - builder
```
public static HyperParameterTuningJobSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HyperParameterTuningJobSummary.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)
```
  - 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 HyperParameterTuningJobSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hyperParameterTuningJobName

hyperParameterTuningJobArn

hyperParameterTuningJobStatus

hyperParameterTuningJobStatusAsString

strategy

strategyAsString

creationTime

hyperParameterTuningEndTime

lastModifiedTime

trainingJobStatusCounters

objectiveStatusCounters

resourceLimits

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields