HyperParameterTuningJobSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.HyperParameterTuningJobSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HyperParameterTuningJobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides summary information about a hyperparameter tuning job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HyperParameterTuningJobSummary()

Constructors
Constructor and Description
`HyperParameterTuningJobSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HyperParameterTuningJobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The date and time that the tuning job was created.
`Date`	`getHyperParameterTuningEndTime()` The date and time that the tuning job ended.
`String`	`getHyperParameterTuningJobArn()` The Amazon Resource Name (ARN) of the tuning job.
`String`	`getHyperParameterTuningJobName()` The name of the tuning job.
`String`	`getHyperParameterTuningJobStatus()` The status of the tuning job.
`Date`	`getLastModifiedTime()` The date and time that the tuning job was modified.
`ObjectiveStatusCounters`	`getObjectiveStatusCounters()` The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
`ResourceLimits`	`getResourceLimits()` The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
`String`	`getStrategy()` Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration.
`TrainingJobStatusCounters`	`getTrainingJobStatusCounters()` The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` The date and time that the tuning job was created.
`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`	`setHyperParameterTuningJobName(String hyperParameterTuningJobName)` The name of the tuning job.
`void`	`setHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)` The status of the tuning job.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The date and time that the tuning job was modified.
`void`	`setObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)` The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
`void`	`setResourceLimits(ResourceLimits resourceLimits)` The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
`void`	`setStrategy(String strategy)` Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration.
`void`	`setTrainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)` The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
`String`	`toString()` Returns a string representation of this object.
`HyperParameterTuningJobSummary`	`withCreationTime(Date creationTime)` The date and time that the tuning job was created.
`HyperParameterTuningJobSummary`	`withHyperParameterTuningEndTime(Date hyperParameterTuningEndTime)` The date and time that the tuning job ended.
`HyperParameterTuningJobSummary`	`withHyperParameterTuningJobArn(String hyperParameterTuningJobArn)` The Amazon Resource Name (ARN) of the tuning job.
`HyperParameterTuningJobSummary`	`withHyperParameterTuningJobName(String hyperParameterTuningJobName)` The name of the tuning job.
`HyperParameterTuningJobSummary`	`withHyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)` The status of the tuning job.
`HyperParameterTuningJobSummary`	`withHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)` The status of the tuning job.
`HyperParameterTuningJobSummary`	`withLastModifiedTime(Date lastModifiedTime)` The date and time that the tuning job was modified.
`HyperParameterTuningJobSummary`	`withObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)` The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
`HyperParameterTuningJobSummary`	`withResourceLimits(ResourceLimits resourceLimits)` The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
`HyperParameterTuningJobSummary`	`withStrategy(HyperParameterTuningJobStrategyType strategy)` Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration.
`HyperParameterTuningJobSummary`	`withStrategy(String strategy)` Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration.
`HyperParameterTuningJobSummary`	`withTrainingJobStatusCounters(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

- Constructor Detail
  - HyperParameterTuningJobSummary
```
public HyperParameterTuningJobSummary()
```
- 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 HyperParameterTuningJobSummary 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 HyperParameterTuningJobSummary 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.
  - setHyperParameterTuningJobStatus
```
public void setHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)
```
    The status of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobStatus - The status of the tuning job.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - getHyperParameterTuningJobStatus
```
public String getHyperParameterTuningJobStatus()
```
    The status of the tuning job.
    
    Returns:
    
    The status of the tuning job.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - withHyperParameterTuningJobStatus
```
public HyperParameterTuningJobSummary withHyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)
```
    The status of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobStatus - The status of the tuning job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - withHyperParameterTuningJobStatus
```
public HyperParameterTuningJobSummary withHyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)
```
    The status of the tuning job.
    
    Parameters:
    
    hyperParameterTuningJobStatus - The status of the tuning job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - setStrategy
```
public void setStrategy(String strategy)
```
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    Parameters:
    
    strategy - 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
  - getStrategy
```
public String getStrategy()
```
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    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
  - withStrategy
```
public HyperParameterTuningJobSummary withStrategy(String strategy)
```
    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    Parameters:
    
    strategy - Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStrategyType
  - withStrategy
```
public HyperParameterTuningJobSummary withStrategy(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.
    
    Parameters:
    
    strategy - Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStrategyType
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time that the tuning job was created.
    
    Parameters:
    
    creationTime - The date and time that the tuning job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time that the tuning job was created.
    
    Returns:
    
    The date and time that the tuning job was created.
  - withCreationTime
```
public HyperParameterTuningJobSummary withCreationTime(Date creationTime)
```
    The date and time that the tuning job was created.
    
    Parameters:
    
    creationTime - The date and time that the tuning job was created.
    
    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 HyperParameterTuningJobSummary 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 tuning job was modified.
    
    Parameters:
    
    lastModifiedTime - The date and time that the tuning job was modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The date and time that the tuning job was modified.
    
    Returns:
    
    The date and time that the tuning job was modified.
  - withLastModifiedTime
```
public HyperParameterTuningJobSummary withLastModifiedTime(Date lastModifiedTime)
```
    The date and time that the tuning job was modified.
    
    Parameters:
    
    lastModifiedTime - The date and time that 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 numbers of training jobs, categorized by status, that this tuning job launched.
    
    Parameters:
    
    trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
  - getTrainingJobStatusCounters
```
public TrainingJobStatusCounters getTrainingJobStatusCounters()
```
    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.
  - withTrainingJobStatusCounters
```
public HyperParameterTuningJobSummary withTrainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)
```
    The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
    
    Parameters:
    
    trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the numbers 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 numbers of training jobs, categorized by objective metric status, that this tuning job launched.
    
    Parameters:
    
    objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
  - getObjectiveStatusCounters
```
public ObjectiveStatusCounters getObjectiveStatusCounters()
```
    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.
  - withObjectiveStatusCounters
```
public HyperParameterTuningJobSummary withObjectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)
```
    The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
    
    Parameters:
    
    objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceLimits
```
public void setResourceLimits(ResourceLimits resourceLimits)
```
    The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
    
    Parameters:
    
    resourceLimits - The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
  - getResourceLimits
```
public ResourceLimits getResourceLimits()
```
    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.
  - withResourceLimits
```
public HyperParameterTuningJobSummary withResourceLimits(ResourceLimits resourceLimits)
```
    The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
    
    Parameters:
    
    resourceLimits - The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 HyperParameterTuningJobSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class HyperParameterTuningJobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HyperParameterTuningJobSummary

Method Detail

setHyperParameterTuningJobName

getHyperParameterTuningJobName

withHyperParameterTuningJobName

setHyperParameterTuningJobArn

getHyperParameterTuningJobArn

withHyperParameterTuningJobArn

setHyperParameterTuningJobStatus

getHyperParameterTuningJobStatus

withHyperParameterTuningJobStatus

withHyperParameterTuningJobStatus

setStrategy

getStrategy

withStrategy

withStrategy

setCreationTime

getCreationTime

withCreationTime

setHyperParameterTuningEndTime

getHyperParameterTuningEndTime

withHyperParameterTuningEndTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setTrainingJobStatusCounters

getTrainingJobStatusCounters

withTrainingJobStatusCounters

setObjectiveStatusCounters

getObjectiveStatusCounters

withObjectiveStatusCounters

setResourceLimits

getResourceLimits

withResourceLimits

toString

equals

hashCode

clone

marshall