@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeModelResult() |
Modifier and Type | Method and Description |
---|---|
DescribeModelResult |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedAt()
Indicates the time and date at which the ML model was created.
|
DataPreProcessingConfiguration |
getDataPreProcessingConfiguration()
The configuration is the
TargetSamplingRate , which is the sampling rate of the data after post
processing by Amazon Lookout for Equipment. |
String |
getDatasetArn()
The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
|
String |
getDatasetName()
The name of the dataset being used by the ML being described.
|
Date |
getEvaluationDataEndTime()
Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
|
Date |
getEvaluationDataStartTime()
Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML
model.
|
String |
getFailedReason()
If the training of the ML model failed, this indicates the reason for that failure.
|
LabelsInputConfiguration |
getLabelsInputConfiguration()
Specifies configuration information about the labels input, including its S3 location.
|
Date |
getLastUpdatedTime()
Indicates the last time the ML model was updated.
|
String |
getModelArn()
The Amazon Resource Name (ARN) of the ML model being described.
|
String |
getModelMetrics()
The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
|
String |
getModelName()
The name of the ML model being described.
|
String |
getOffCondition()
Indicates that the asset associated with this sensor has been shut off.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being
described.
|
String |
getSchema()
A JSON description of the data that is in each time series dataset, including names, column names, and data
types.
|
String |
getServerSideKmsKeyId()
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
|
String |
getStatus()
Specifies the current status of the model being described.
|
Date |
getTrainingDataEndTime()
Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
|
Date |
getTrainingDataStartTime()
Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
|
Date |
getTrainingExecutionEndTime()
Indicates the time at which the training of the ML model was completed.
|
Date |
getTrainingExecutionStartTime()
Indicates the time at which the training of the ML model began.
|
int |
hashCode() |
void |
setCreatedAt(Date createdAt)
Indicates the time and date at which the ML model was created.
|
void |
setDataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration)
The configuration is the
TargetSamplingRate , which is the sampling rate of the data after post
processing by Amazon Lookout for Equipment. |
void |
setDatasetArn(String datasetArn)
The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
|
void |
setDatasetName(String datasetName)
The name of the dataset being used by the ML being described.
|
void |
setEvaluationDataEndTime(Date evaluationDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
|
void |
setEvaluationDataStartTime(Date evaluationDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML
model.
|
void |
setFailedReason(String failedReason)
If the training of the ML model failed, this indicates the reason for that failure.
|
void |
setLabelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)
Specifies configuration information about the labels input, including its S3 location.
|
void |
setLastUpdatedTime(Date lastUpdatedTime)
Indicates the last time the ML model was updated.
|
void |
setModelArn(String modelArn)
The Amazon Resource Name (ARN) of the ML model being described.
|
void |
setModelMetrics(String modelMetrics)
The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
|
void |
setModelName(String modelName)
The name of the ML model being described.
|
void |
setOffCondition(String offCondition)
Indicates that the asset associated with this sensor has been shut off.
|
void |
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being
described.
|
void |
setSchema(String schema)
A JSON description of the data that is in each time series dataset, including names, column names, and data
types.
|
void |
setServerSideKmsKeyId(String serverSideKmsKeyId)
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
|
void |
setStatus(String status)
Specifies the current status of the model being described.
|
void |
setTrainingDataEndTime(Date trainingDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
|
void |
setTrainingDataStartTime(Date trainingDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
|
void |
setTrainingExecutionEndTime(Date trainingExecutionEndTime)
Indicates the time at which the training of the ML model was completed.
|
void |
setTrainingExecutionStartTime(Date trainingExecutionStartTime)
Indicates the time at which the training of the ML model began.
|
String |
toString()
Returns a string representation of this object.
|
DescribeModelResult |
withCreatedAt(Date createdAt)
Indicates the time and date at which the ML model was created.
|
DescribeModelResult |
withDataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration)
The configuration is the
TargetSamplingRate , which is the sampling rate of the data after post
processing by Amazon Lookout for Equipment. |
DescribeModelResult |
withDatasetArn(String datasetArn)
The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
|
DescribeModelResult |
withDatasetName(String datasetName)
The name of the dataset being used by the ML being described.
|
DescribeModelResult |
withEvaluationDataEndTime(Date evaluationDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
|
DescribeModelResult |
withEvaluationDataStartTime(Date evaluationDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML
model.
|
DescribeModelResult |
withFailedReason(String failedReason)
If the training of the ML model failed, this indicates the reason for that failure.
|
DescribeModelResult |
withLabelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)
Specifies configuration information about the labels input, including its S3 location.
|
DescribeModelResult |
withLastUpdatedTime(Date lastUpdatedTime)
Indicates the last time the ML model was updated.
|
DescribeModelResult |
withModelArn(String modelArn)
The Amazon Resource Name (ARN) of the ML model being described.
|
DescribeModelResult |
withModelMetrics(String modelMetrics)
The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
|
DescribeModelResult |
withModelName(String modelName)
The name of the ML model being described.
|
DescribeModelResult |
withOffCondition(String offCondition)
Indicates that the asset associated with this sensor has been shut off.
|
DescribeModelResult |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being
described.
|
DescribeModelResult |
withSchema(String schema)
A JSON description of the data that is in each time series dataset, including names, column names, and data
types.
|
DescribeModelResult |
withServerSideKmsKeyId(String serverSideKmsKeyId)
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
|
DescribeModelResult |
withStatus(ModelStatus status)
Specifies the current status of the model being described.
|
DescribeModelResult |
withStatus(String status)
Specifies the current status of the model being described.
|
DescribeModelResult |
withTrainingDataEndTime(Date trainingDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
|
DescribeModelResult |
withTrainingDataStartTime(Date trainingDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
|
DescribeModelResult |
withTrainingExecutionEndTime(Date trainingExecutionEndTime)
Indicates the time at which the training of the ML model was completed.
|
DescribeModelResult |
withTrainingExecutionStartTime(Date trainingExecutionStartTime)
Indicates the time at which the training of the ML model began.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setModelName(String modelName)
The name of the ML model being described.
modelName
- The name of the ML model being described.public String getModelName()
The name of the ML model being described.
public DescribeModelResult withModelName(String modelName)
The name of the ML model being described.
modelName
- The name of the ML model being described.public void setModelArn(String modelArn)
The Amazon Resource Name (ARN) of the ML model being described.
modelArn
- The Amazon Resource Name (ARN) of the ML model being described.public String getModelArn()
The Amazon Resource Name (ARN) of the ML model being described.
public DescribeModelResult withModelArn(String modelArn)
The Amazon Resource Name (ARN) of the ML model being described.
modelArn
- The Amazon Resource Name (ARN) of the ML model being described.public void setDatasetName(String datasetName)
The name of the dataset being used by the ML being described.
datasetName
- The name of the dataset being used by the ML being described.public String getDatasetName()
The name of the dataset being used by the ML being described.
public DescribeModelResult withDatasetName(String datasetName)
The name of the dataset being used by the ML being described.
datasetName
- The name of the dataset being used by the ML being described.public void setDatasetArn(String datasetArn)
The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
datasetArn
- The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.public String getDatasetArn()
The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
public DescribeModelResult withDatasetArn(String datasetArn)
The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
datasetArn
- The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.public void setSchema(String schema)
A JSON description of the data that is in each time series dataset, including names, column names, and data types.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
schema
- A JSON description of the data that is in each time series dataset, including names, column names, and
data types.public String getSchema()
A JSON description of the data that is in each time series dataset, including names, column names, and data types.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
public DescribeModelResult withSchema(String schema)
A JSON description of the data that is in each time series dataset, including names, column names, and data types.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
schema
- A JSON description of the data that is in each time series dataset, including names, column names, and
data types.public void setLabelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)
Specifies configuration information about the labels input, including its S3 location.
labelsInputConfiguration
- Specifies configuration information about the labels input, including its S3 location.public LabelsInputConfiguration getLabelsInputConfiguration()
Specifies configuration information about the labels input, including its S3 location.
public DescribeModelResult withLabelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)
Specifies configuration information about the labels input, including its S3 location.
labelsInputConfiguration
- Specifies configuration information about the labels input, including its S3 location.public void setTrainingDataStartTime(Date trainingDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
trainingDataStartTime
- Indicates the time reference in the dataset that was used to begin the subset of training data for the ML
model.public Date getTrainingDataStartTime()
Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
public DescribeModelResult withTrainingDataStartTime(Date trainingDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
trainingDataStartTime
- Indicates the time reference in the dataset that was used to begin the subset of training data for the ML
model.public void setTrainingDataEndTime(Date trainingDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
trainingDataEndTime
- Indicates the time reference in the dataset that was used to end the subset of training data for the ML
model.public Date getTrainingDataEndTime()
Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
public DescribeModelResult withTrainingDataEndTime(Date trainingDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
trainingDataEndTime
- Indicates the time reference in the dataset that was used to end the subset of training data for the ML
model.public void setEvaluationDataStartTime(Date evaluationDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
evaluationDataStartTime
- Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the
ML model.public Date getEvaluationDataStartTime()
Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
public DescribeModelResult withEvaluationDataStartTime(Date evaluationDataStartTime)
Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
evaluationDataStartTime
- Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the
ML model.public void setEvaluationDataEndTime(Date evaluationDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
evaluationDataEndTime
- Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML
model.public Date getEvaluationDataEndTime()
Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
public DescribeModelResult withEvaluationDataEndTime(Date evaluationDataEndTime)
Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
evaluationDataEndTime
- Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML
model.public void setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.
roleArn
- The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being
described.public String getRoleArn()
The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.
public DescribeModelResult withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.
roleArn
- The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being
described.public void setDataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration)
The configuration is the TargetSamplingRate
, which is the sampling rate of the data after post
processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1
second level and you want the system to resample the data at a 1 minute rate before training, the
TargetSamplingRate
is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
the value for a 1 hour rate is PT1H
dataPreProcessingConfiguration
- The configuration is the TargetSamplingRate
, which is the sampling rate of the data after
post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected
at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the
TargetSamplingRate
is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
PT15M, and the value for a 1 hour rate is PT1H
public DataPreProcessingConfiguration getDataPreProcessingConfiguration()
The configuration is the TargetSamplingRate
, which is the sampling rate of the data after post
processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1
second level and you want the system to resample the data at a 1 minute rate before training, the
TargetSamplingRate
is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
the value for a 1 hour rate is PT1H
TargetSamplingRate
, which is the sampling rate of the data after
post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected
at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the
TargetSamplingRate
is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
PT15M, and the value for a 1 hour rate is PT1H
public DescribeModelResult withDataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration)
The configuration is the TargetSamplingRate
, which is the sampling rate of the data after post
processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1
second level and you want the system to resample the data at a 1 minute rate before training, the
TargetSamplingRate
is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the rate you
want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and
the value for a 1 hour rate is PT1H
dataPreProcessingConfiguration
- The configuration is the TargetSamplingRate
, which is the sampling rate of the data after
post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected
at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the
TargetSamplingRate
is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the prefix "PT" to the
rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is
PT15M, and the value for a 1 hour rate is PT1H
public void setStatus(String status)
Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
status
- Specifies the current status of the model being described. Status describes the status of the most recent
action of the model.ModelStatus
public String getStatus()
Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
ModelStatus
public DescribeModelResult withStatus(String status)
Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
status
- Specifies the current status of the model being described. Status describes the status of the most recent
action of the model.ModelStatus
public DescribeModelResult withStatus(ModelStatus status)
Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
status
- Specifies the current status of the model being described. Status describes the status of the most recent
action of the model.ModelStatus
public void setTrainingExecutionStartTime(Date trainingExecutionStartTime)
Indicates the time at which the training of the ML model began.
trainingExecutionStartTime
- Indicates the time at which the training of the ML model began.public Date getTrainingExecutionStartTime()
Indicates the time at which the training of the ML model began.
public DescribeModelResult withTrainingExecutionStartTime(Date trainingExecutionStartTime)
Indicates the time at which the training of the ML model began.
trainingExecutionStartTime
- Indicates the time at which the training of the ML model began.public void setTrainingExecutionEndTime(Date trainingExecutionEndTime)
Indicates the time at which the training of the ML model was completed.
trainingExecutionEndTime
- Indicates the time at which the training of the ML model was completed.public Date getTrainingExecutionEndTime()
Indicates the time at which the training of the ML model was completed.
public DescribeModelResult withTrainingExecutionEndTime(Date trainingExecutionEndTime)
Indicates the time at which the training of the ML model was completed.
trainingExecutionEndTime
- Indicates the time at which the training of the ML model was completed.public void setFailedReason(String failedReason)
If the training of the ML model failed, this indicates the reason for that failure.
failedReason
- If the training of the ML model failed, this indicates the reason for that failure.public String getFailedReason()
If the training of the ML model failed, this indicates the reason for that failure.
public DescribeModelResult withFailedReason(String failedReason)
If the training of the ML model failed, this indicates the reason for that failure.
failedReason
- If the training of the ML model failed, this indicates the reason for that failure.public void setModelMetrics(String modelMetrics)
The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
modelMetrics
- The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
This is the JSON content of the metrics created when evaluating the model.public String getModelMetrics()
The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
public DescribeModelResult withModelMetrics(String modelMetrics)
The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
modelMetrics
- The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
This is the JSON content of the metrics created when evaluating the model.public void setLastUpdatedTime(Date lastUpdatedTime)
Indicates the last time the ML model was updated. The type of update is not specified.
lastUpdatedTime
- Indicates the last time the ML model was updated. The type of update is not specified.public Date getLastUpdatedTime()
Indicates the last time the ML model was updated. The type of update is not specified.
public DescribeModelResult withLastUpdatedTime(Date lastUpdatedTime)
Indicates the last time the ML model was updated. The type of update is not specified.
lastUpdatedTime
- Indicates the last time the ML model was updated. The type of update is not specified.public void setCreatedAt(Date createdAt)
Indicates the time and date at which the ML model was created.
createdAt
- Indicates the time and date at which the ML model was created.public Date getCreatedAt()
Indicates the time and date at which the ML model was created.
public DescribeModelResult withCreatedAt(Date createdAt)
Indicates the time and date at which the ML model was created.
createdAt
- Indicates the time and date at which the ML model was created.public void setServerSideKmsKeyId(String serverSideKmsKeyId)
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
serverSideKmsKeyId
- Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.public String getServerSideKmsKeyId()
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
public DescribeModelResult withServerSideKmsKeyId(String serverSideKmsKeyId)
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
serverSideKmsKeyId
- Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.public void setOffCondition(String offCondition)
Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
offCondition
- Indicates that the asset associated with this sensor has been shut off. As long as this condition is met,
Lookout for Equipment will not use data from this asset for training, evaluation, or inference.public String getOffCondition()
Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
public DescribeModelResult withOffCondition(String offCondition)
Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
offCondition
- Indicates that the asset associated with this sensor has been shut off. As long as this condition is met,
Lookout for Equipment will not use data from this asset for training, evaluation, or inference.public String toString()
toString
in class Object
Object.toString()
public DescribeModelResult clone()