HyperParameterTuningJobSearchEntity (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HyperParameterTuningJobSearchEntity.Builder,HyperParameterTuningJobSearchEntity>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class HyperParameterTuningJobSearchEntity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterTuningJobSearchEntity.Builder,HyperParameterTuningJobSearchEntity>
```
An entity having characteristics over which a user can search for a hyperparameter tuning job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HyperParameterTuningJobSearchEntity.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HyperParameterTrainingJobSummary`	`bestTrainingJob()` Returns the value of the BestTrainingJob property for this object.
`static HyperParameterTuningJobSearchEntity.Builder`	`builder()`
`Instant`	`creationTime()` The time that a hyperparameter tuning job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` The error that was created when a hyperparameter tuning job failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTrainingJobDefinitions()` For responses, this returns true if the service returned a value for the TrainingJobDefinitions property.
`Instant`	`hyperParameterTuningEndTime()` The time that a hyperparameter tuning job ended.
`String`	`hyperParameterTuningJobArn()` The Amazon Resource Name (ARN) of a hyperparameter tuning job.
`HyperParameterTuningJobConfig`	`hyperParameterTuningJobConfig()` Returns the value of the HyperParameterTuningJobConfig property for this object.
`String`	`hyperParameterTuningJobName()` The name of a hyperparameter tuning job.
`HyperParameterTuningJobStatus`	`hyperParameterTuningJobStatus()` The status of a hyperparameter tuning job.
`String`	`hyperParameterTuningJobStatusAsString()` The status of a hyperparameter tuning job.
`Instant`	`lastModifiedTime()` The time that a hyperparameter tuning job was last modified.
`ObjectiveStatusCounters`	`objectiveStatusCounters()` Returns the value of the ObjectiveStatusCounters property for this object.
`HyperParameterTrainingJobSummary`	`overallBestTrainingJob()` Returns the value of the OverallBestTrainingJob property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HyperParameterTuningJobSearchEntity.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` The tags associated with a hyperparameter tuning job.
`HyperParameterTuningJobSearchEntity.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`HyperParameterTrainingJobDefinition`	`trainingJobDefinition()` Returns the value of the TrainingJobDefinition property for this object.
`List<HyperParameterTrainingJobDefinition>`	`trainingJobDefinitions()` The job definitions included in a hyperparameter tuning job.
`TrainingJobStatusCounters`	`trainingJobStatusCounters()` Returns the value of the TrainingJobStatusCounters property for this object.
`HyperParameterTuningJobWarmStartConfig`	`warmStartConfig()` Returns the value of the WarmStartConfig property for this object.

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 a hyperparameter tuning job.
    
    Returns:
    
    The name of a hyperparameter tuning job.
  - hyperParameterTuningJobArn
```
public final String hyperParameterTuningJobArn()
```
    The Amazon Resource Name (ARN) of a hyperparameter tuning job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a hyperparameter tuning job.
  - hyperParameterTuningJobConfig
```
public final HyperParameterTuningJobConfig hyperParameterTuningJobConfig()
```
    Returns the value of the HyperParameterTuningJobConfig property for this object.
    
    Returns:
    
    The value of the HyperParameterTuningJobConfig property for this object.
  - trainingJobDefinition
```
public final HyperParameterTrainingJobDefinition trainingJobDefinition()
```
    Returns the value of the TrainingJobDefinition property for this object.
    
    Returns:
    
    The value of the TrainingJobDefinition property for this object.
  - 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()
```
    The job definitions included in a hyperparameter 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:
    
    The job definitions included in a hyperparameter tuning job.
  - hyperParameterTuningJobStatus
```
public final HyperParameterTuningJobStatus hyperParameterTuningJobStatus()
```
    The status of a hyperparameter 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 a hyperparameter tuning job.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - hyperParameterTuningJobStatusAsString
```
public final String hyperParameterTuningJobStatusAsString()
```
    The status of a hyperparameter 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 a hyperparameter tuning job.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - creationTime
```
public final Instant creationTime()
```
    The time that a hyperparameter tuning job was created.
    
    Returns:
    
    The time that a hyperparameter tuning job was created.
  - hyperParameterTuningEndTime
```
public final Instant hyperParameterTuningEndTime()
```
    The time that a hyperparameter tuning job ended.
    
    Returns:
    
    The time that a hyperparameter tuning job ended.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The time that a hyperparameter tuning job was last modified.
    
    Returns:
    
    The time that a hyperparameter tuning job was last modified.
  - trainingJobStatusCounters
```
public final TrainingJobStatusCounters trainingJobStatusCounters()
```
    Returns the value of the TrainingJobStatusCounters property for this object.
    
    Returns:
    
    The value of the TrainingJobStatusCounters property for this object.
  - objectiveStatusCounters
```
public final ObjectiveStatusCounters objectiveStatusCounters()
```
    Returns the value of the ObjectiveStatusCounters property for this object.
    
    Returns:
    
    The value of the ObjectiveStatusCounters property for this object.
  - bestTrainingJob
```
public final HyperParameterTrainingJobSummary bestTrainingJob()
```
    Returns the value of the BestTrainingJob property for this object.
    
    Returns:
    
    The value of the BestTrainingJob property for this object.
  - overallBestTrainingJob
```
public final HyperParameterTrainingJobSummary overallBestTrainingJob()
```
    Returns the value of the OverallBestTrainingJob property for this object.
    
    Returns:
    
    The value of the OverallBestTrainingJob property for this object.
  - warmStartConfig
```
public final HyperParameterTuningJobWarmStartConfig warmStartConfig()
```
    Returns the value of the WarmStartConfig property for this object.
    
    Returns:
    
    The value of the WarmStartConfig property for this object.
  - failureReason
```
public final String failureReason()
```
    The error that was created when a hyperparameter tuning job failed.
    
    Returns:
    
    The error that was created when a hyperparameter tuning job failed.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
    
    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 hasTags() method.
    
    Returns:
    
    The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
  - toBuilder
```
public HyperParameterTuningJobSearchEntity.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HyperParameterTuningJobSearchEntity.Builder,HyperParameterTuningJobSearchEntity>
  - builder
```
public static HyperParameterTuningJobSearchEntity.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HyperParameterTuningJobSearchEntity.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class HyperParameterTuningJobSearchEntity

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

hyperParameterTuningJobConfig

trainingJobDefinition

hasTrainingJobDefinitions

trainingJobDefinitions

hyperParameterTuningJobStatus

hyperParameterTuningJobStatusAsString

creationTime

hyperParameterTuningEndTime

lastModifiedTime

trainingJobStatusCounters

objectiveStatusCounters

bestTrainingJob

overallBestTrainingJob

warmStartConfig

failureReason

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields