@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeTrainingJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeTrainingJobResult() |
Modifier and Type | Method and Description |
---|---|
DescribeTrainingJobResult |
addHyperParametersEntry(String key,
String value) |
DescribeTrainingJobResult |
clearHyperParametersEntries()
Removes all the entries added into HyperParameters.
|
DescribeTrainingJobResult |
clone() |
boolean |
equals(Object obj) |
AlgorithmSpecification |
getAlgorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
|
Date |
getCreationTime()
A timestamp that indicates when the training job was created.
|
String |
getFailureReason()
If the training job failed, the reason it failed.
|
Map<String,String> |
getHyperParameters()
Algorithm-specific parameters.
|
List<Channel> |
getInputDataConfig()
An array of
Channel objects that describes each data input channel. |
Date |
getLastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
|
ModelArtifacts |
getModelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
|
OutputDataConfig |
getOutputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored.
|
ResourceConfig |
getResourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
String |
getRoleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
|
String |
getSecondaryStatus()
Provides granular information about the system state.
|
StoppingCondition |
getStoppingCondition()
The condition under which to stop the training job.
|
Date |
getTrainingEndTime()
A timestamp that indicates when model training ended.
|
String |
getTrainingJobArn()
The Amazon Resource Name (ARN) of the training job.
|
String |
getTrainingJobName()
Name of the model training job.
|
String |
getTrainingJobStatus()
The status of the training job.
|
Date |
getTrainingStartTime()
A timestamp that indicates when training started.
|
VpcConfig |
getVpcConfig()
A object that specifies the VPC that this training job has access to.
|
int |
hashCode() |
void |
setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
|
void |
setCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
|
void |
setFailureReason(String failureReason)
If the training job failed, the reason it failed.
|
void |
setHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
|
void |
setInputDataConfig(Collection<Channel> inputDataConfig)
An array of
Channel objects that describes each data input channel. |
void |
setLastModifiedTime(Date lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
|
void |
setModelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
|
void |
setOutputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored.
|
void |
setResourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
void |
setRoleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
|
void |
setSecondaryStatus(String secondaryStatus)
Provides granular information about the system state.
|
void |
setStoppingCondition(StoppingCondition stoppingCondition)
The condition under which to stop the training job.
|
void |
setTrainingEndTime(Date trainingEndTime)
A timestamp that indicates when model training ended.
|
void |
setTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
|
void |
setTrainingJobName(String trainingJobName)
Name of the model training job.
|
void |
setTrainingJobStatus(String trainingJobStatus)
The status of the training job.
|
void |
setTrainingStartTime(Date trainingStartTime)
A timestamp that indicates when training started.
|
void |
setVpcConfig(VpcConfig vpcConfig)
A object that specifies the VPC that this training job has access to.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
DescribeTrainingJobResult |
withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
|
DescribeTrainingJobResult |
withCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
|
DescribeTrainingJobResult |
withFailureReason(String failureReason)
If the training job failed, the reason it failed.
|
DescribeTrainingJobResult |
withHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
|
DescribeTrainingJobResult |
withInputDataConfig(Channel... inputDataConfig)
An array of
Channel objects that describes each data input channel. |
DescribeTrainingJobResult |
withInputDataConfig(Collection<Channel> inputDataConfig)
An array of
Channel objects that describes each data input channel. |
DescribeTrainingJobResult |
withLastModifiedTime(Date lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
|
DescribeTrainingJobResult |
withModelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
|
DescribeTrainingJobResult |
withOutputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored.
|
DescribeTrainingJobResult |
withResourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
DescribeTrainingJobResult |
withRoleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
|
DescribeTrainingJobResult |
withSecondaryStatus(SecondaryStatus secondaryStatus)
Provides granular information about the system state.
|
DescribeTrainingJobResult |
withSecondaryStatus(String secondaryStatus)
Provides granular information about the system state.
|
DescribeTrainingJobResult |
withStoppingCondition(StoppingCondition stoppingCondition)
The condition under which to stop the training job.
|
DescribeTrainingJobResult |
withTrainingEndTime(Date trainingEndTime)
A timestamp that indicates when model training ended.
|
DescribeTrainingJobResult |
withTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
|
DescribeTrainingJobResult |
withTrainingJobName(String trainingJobName)
Name of the model training job.
|
DescribeTrainingJobResult |
withTrainingJobStatus(String trainingJobStatus)
The status of the training job.
|
DescribeTrainingJobResult |
withTrainingJobStatus(TrainingJobStatus trainingJobStatus)
The status of the training job.
|
DescribeTrainingJobResult |
withTrainingStartTime(Date trainingStartTime)
A timestamp that indicates when training started.
|
DescribeTrainingJobResult |
withVpcConfig(VpcConfig vpcConfig)
A object that specifies the VPC that this training job has access to.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setTrainingJobName(String trainingJobName)
Name of the model training job.
trainingJobName
- Name of the model training job.public String getTrainingJobName()
Name of the model training job.
public DescribeTrainingJobResult withTrainingJobName(String trainingJobName)
Name of the model training job.
trainingJobName
- Name of the model training job.public void setTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
trainingJobArn
- The Amazon Resource Name (ARN) of the training job.public String getTrainingJobArn()
The Amazon Resource Name (ARN) of the training job.
public DescribeTrainingJobResult withTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
trainingJobArn
- The Amazon Resource Name (ARN) of the training job.public void setModelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
modelArtifacts
- Information about the Amazon S3 location that is configured for storing model artifacts.public ModelArtifacts getModelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
public DescribeTrainingJobResult withModelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
modelArtifacts
- Information about the Amazon S3 location that is configured for storing model artifacts.public void setTrainingJobStatus(String trainingJobStatus)
The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
trainingJobStatus
- The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
TrainingJobStatus
public String getTrainingJobStatus()
The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
TrainingJobStatus
public DescribeTrainingJobResult withTrainingJobStatus(String trainingJobStatus)
The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
trainingJobStatus
- The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
TrainingJobStatus
public DescribeTrainingJobResult withTrainingJobStatus(TrainingJobStatus trainingJobStatus)
The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
trainingJobStatus
- The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
TrainingJobStatus
public void setSecondaryStatus(String secondaryStatus)
Provides granular information about the system state. For more information, see TrainingJobStatus
.
secondaryStatus
- Provides granular information about the system state. For more information, see
TrainingJobStatus
.SecondaryStatus
public String getSecondaryStatus()
Provides granular information about the system state. For more information, see TrainingJobStatus
.
TrainingJobStatus
.SecondaryStatus
public DescribeTrainingJobResult withSecondaryStatus(String secondaryStatus)
Provides granular information about the system state. For more information, see TrainingJobStatus
.
secondaryStatus
- Provides granular information about the system state. For more information, see
TrainingJobStatus
.SecondaryStatus
public DescribeTrainingJobResult withSecondaryStatus(SecondaryStatus secondaryStatus)
Provides granular information about the system state. For more information, see TrainingJobStatus
.
secondaryStatus
- Provides granular information about the system state. For more information, see
TrainingJobStatus
.SecondaryStatus
public void setFailureReason(String failureReason)
If the training job failed, the reason it failed.
failureReason
- If the training job failed, the reason it failed.public String getFailureReason()
If the training job failed, the reason it failed.
public DescribeTrainingJobResult withFailureReason(String failureReason)
If the training job failed, the reason it failed.
failureReason
- If the training job failed, the reason it failed.public Map<String,String> getHyperParameters()
Algorithm-specific parameters.
public void setHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
hyperParameters
- Algorithm-specific parameters.public DescribeTrainingJobResult withHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
hyperParameters
- Algorithm-specific parameters.public DescribeTrainingJobResult addHyperParametersEntry(String key, String value)
public DescribeTrainingJobResult clearHyperParametersEntries()
public void setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
algorithmSpecification
- Information about the algorithm used for training, and algorithm metadata.public AlgorithmSpecification getAlgorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
public DescribeTrainingJobResult withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
algorithmSpecification
- Information about the algorithm used for training, and algorithm metadata.public void setRoleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
roleArn
- The AWS Identity and Access Management (IAM) role configured for the training job.public String getRoleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
public DescribeTrainingJobResult withRoleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
roleArn
- The AWS Identity and Access Management (IAM) role configured for the training job.public List<Channel> getInputDataConfig()
An array of Channel
objects that describes each data input channel.
Channel
objects that describes each data input channel.public void setInputDataConfig(Collection<Channel> inputDataConfig)
An array of Channel
objects that describes each data input channel.
inputDataConfig
- An array of Channel
objects that describes each data input channel.public DescribeTrainingJobResult withInputDataConfig(Channel... inputDataConfig)
An array of Channel
objects that describes each data input channel.
NOTE: This method appends the values to the existing list (if any). Use
setInputDataConfig(java.util.Collection)
or withInputDataConfig(java.util.Collection)
if you
want to override the existing values.
inputDataConfig
- An array of Channel
objects that describes each data input channel.public DescribeTrainingJobResult withInputDataConfig(Collection<Channel> inputDataConfig)
An array of Channel
objects that describes each data input channel.
inputDataConfig
- An array of Channel
objects that describes each data input channel.public void setOutputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
outputDataConfig
- The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker
creates subfolders for model artifacts.public OutputDataConfig getOutputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
public DescribeTrainingJobResult withOutputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
outputDataConfig
- The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker
creates subfolders for model artifacts.public void setResourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
resourceConfig
- Resources, including ML compute instances and ML storage volumes, that are configured for model training.public ResourceConfig getResourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
public DescribeTrainingJobResult withResourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
resourceConfig
- Resources, including ML compute instances and ML storage volumes, that are configured for model training.public void setVpcConfig(VpcConfig vpcConfig)
A object that specifies the VPC that this training job has access to. For more information, see train-vpc.
vpcConfig
- A object that specifies the VPC that this training job has access to. For more information, see
train-vpc.public VpcConfig getVpcConfig()
A object that specifies the VPC that this training job has access to. For more information, see train-vpc.
public DescribeTrainingJobResult withVpcConfig(VpcConfig vpcConfig)
A object that specifies the VPC that this training job has access to. For more information, see train-vpc.
vpcConfig
- A object that specifies the VPC that this training job has access to. For more information, see
train-vpc.public void setStoppingCondition(StoppingCondition stoppingCondition)
The condition under which to stop the training job.
stoppingCondition
- The condition under which to stop the training job.public StoppingCondition getStoppingCondition()
The condition under which to stop the training job.
public DescribeTrainingJobResult withStoppingCondition(StoppingCondition stoppingCondition)
The condition under which to stop the training job.
stoppingCondition
- The condition under which to stop the training job.public void setCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
creationTime
- A timestamp that indicates when the training job was created.public Date getCreationTime()
A timestamp that indicates when the training job was created.
public DescribeTrainingJobResult withCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
creationTime
- A timestamp that indicates when the training job was created.public void setTrainingStartTime(Date trainingStartTime)
A timestamp that indicates when training started.
trainingStartTime
- A timestamp that indicates when training started.public Date getTrainingStartTime()
A timestamp that indicates when training started.
public DescribeTrainingJobResult withTrainingStartTime(Date trainingStartTime)
A timestamp that indicates when training started.
trainingStartTime
- A timestamp that indicates when training started.public void setTrainingEndTime(Date trainingEndTime)
A timestamp that indicates when model training ended.
trainingEndTime
- A timestamp that indicates when model training ended.public Date getTrainingEndTime()
A timestamp that indicates when model training ended.
public DescribeTrainingJobResult withTrainingEndTime(Date trainingEndTime)
A timestamp that indicates when model training ended.
trainingEndTime
- A timestamp that indicates when model training ended.public void setLastModifiedTime(Date lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
lastModifiedTime
- A timestamp that indicates when the status of the training job was last modified.public Date getLastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
public DescribeTrainingJobResult withLastModifiedTime(Date lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
lastModifiedTime
- A timestamp that indicates when the status of the training job was last modified.public String toString()
toString
in class Object
Object.toString()
public DescribeTrainingJobResult clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.