@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeAutoPredictorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeAutoPredictorResult() |
Modifier and Type | Method and Description |
---|---|
DescribeAutoPredictorResult |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationTime()
The timestamp of the CreateAutoPredictor request.
|
DataConfig |
getDataConfig()
The data configuration for your dataset group and any additional datasets.
|
List<String> |
getDatasetImportJobArns()
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
|
EncryptionConfig |
getEncryptionConfig() |
Long |
getEstimatedTimeRemainingInMinutes()
The estimated time remaining in minutes for the predictor training job to complete.
|
ExplainabilityInfo |
getExplainabilityInfo()
Provides the status and ARN of the Predictor Explainability.
|
List<String> |
getForecastDimensions()
An array of dimension (field) names that specify the attributes used to group your time series.
|
String |
getForecastFrequency()
The frequency of predictions in a forecast.
|
Integer |
getForecastHorizon()
The number of time-steps that the model predicts.
|
List<String> |
getForecastTypes()
The forecast types used during predictor training.
|
Date |
getLastModificationTime()
The last time the resource was modified.
|
String |
getMessage()
In the event of an error, a message detailing the cause of the error.
|
MonitorInfo |
getMonitorInfo()
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
|
String |
getOptimizationMetric()
The accuracy metric used to optimize the predictor.
|
String |
getPredictorArn()
The Amazon Resource Name (ARN) of the predictor
|
String |
getPredictorName()
The name of the predictor.
|
ReferencePredictorSummary |
getReferencePredictorSummary()
The ARN and state of the reference predictor.
|
String |
getStatus()
The status of the predictor.
|
TimeAlignmentBoundary |
getTimeAlignmentBoundary()
The time boundary Forecast uses when aggregating data.
|
int |
hashCode() |
void |
setCreationTime(Date creationTime)
The timestamp of the CreateAutoPredictor request.
|
void |
setDataConfig(DataConfig dataConfig)
The data configuration for your dataset group and any additional datasets.
|
void |
setDatasetImportJobArns(Collection<String> datasetImportJobArns)
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
|
void |
setEncryptionConfig(EncryptionConfig encryptionConfig) |
void |
setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
The estimated time remaining in minutes for the predictor training job to complete.
|
void |
setExplainabilityInfo(ExplainabilityInfo explainabilityInfo)
Provides the status and ARN of the Predictor Explainability.
|
void |
setForecastDimensions(Collection<String> forecastDimensions)
An array of dimension (field) names that specify the attributes used to group your time series.
|
void |
setForecastFrequency(String forecastFrequency)
The frequency of predictions in a forecast.
|
void |
setForecastHorizon(Integer forecastHorizon)
The number of time-steps that the model predicts.
|
void |
setForecastTypes(Collection<String> forecastTypes)
The forecast types used during predictor training.
|
void |
setLastModificationTime(Date lastModificationTime)
The last time the resource was modified.
|
void |
setMessage(String message)
In the event of an error, a message detailing the cause of the error.
|
void |
setMonitorInfo(MonitorInfo monitorInfo)
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
|
void |
setOptimizationMetric(String optimizationMetric)
The accuracy metric used to optimize the predictor.
|
void |
setPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor
|
void |
setPredictorName(String predictorName)
The name of the predictor.
|
void |
setReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary)
The ARN and state of the reference predictor.
|
void |
setStatus(String status)
The status of the predictor.
|
void |
setTimeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary)
The time boundary Forecast uses when aggregating data.
|
String |
toString()
Returns a string representation of this object.
|
DescribeAutoPredictorResult |
withCreationTime(Date creationTime)
The timestamp of the CreateAutoPredictor request.
|
DescribeAutoPredictorResult |
withDataConfig(DataConfig dataConfig)
The data configuration for your dataset group and any additional datasets.
|
DescribeAutoPredictorResult |
withDatasetImportJobArns(Collection<String> datasetImportJobArns)
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
|
DescribeAutoPredictorResult |
withDatasetImportJobArns(String... datasetImportJobArns)
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
|
DescribeAutoPredictorResult |
withEncryptionConfig(EncryptionConfig encryptionConfig) |
DescribeAutoPredictorResult |
withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
The estimated time remaining in minutes for the predictor training job to complete.
|
DescribeAutoPredictorResult |
withExplainabilityInfo(ExplainabilityInfo explainabilityInfo)
Provides the status and ARN of the Predictor Explainability.
|
DescribeAutoPredictorResult |
withForecastDimensions(Collection<String> forecastDimensions)
An array of dimension (field) names that specify the attributes used to group your time series.
|
DescribeAutoPredictorResult |
withForecastDimensions(String... forecastDimensions)
An array of dimension (field) names that specify the attributes used to group your time series.
|
DescribeAutoPredictorResult |
withForecastFrequency(String forecastFrequency)
The frequency of predictions in a forecast.
|
DescribeAutoPredictorResult |
withForecastHorizon(Integer forecastHorizon)
The number of time-steps that the model predicts.
|
DescribeAutoPredictorResult |
withForecastTypes(Collection<String> forecastTypes)
The forecast types used during predictor training.
|
DescribeAutoPredictorResult |
withForecastTypes(String... forecastTypes)
The forecast types used during predictor training.
|
DescribeAutoPredictorResult |
withLastModificationTime(Date lastModificationTime)
The last time the resource was modified.
|
DescribeAutoPredictorResult |
withMessage(String message)
In the event of an error, a message detailing the cause of the error.
|
DescribeAutoPredictorResult |
withMonitorInfo(MonitorInfo monitorInfo)
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
|
DescribeAutoPredictorResult |
withOptimizationMetric(OptimizationMetric optimizationMetric)
The accuracy metric used to optimize the predictor.
|
DescribeAutoPredictorResult |
withOptimizationMetric(String optimizationMetric)
The accuracy metric used to optimize the predictor.
|
DescribeAutoPredictorResult |
withPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor
|
DescribeAutoPredictorResult |
withPredictorName(String predictorName)
The name of the predictor.
|
DescribeAutoPredictorResult |
withReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary)
The ARN and state of the reference predictor.
|
DescribeAutoPredictorResult |
withStatus(String status)
The status of the predictor.
|
DescribeAutoPredictorResult |
withTimeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary)
The time boundary Forecast uses when aggregating data.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor
predictorArn
- The Amazon Resource Name (ARN) of the predictorpublic String getPredictorArn()
The Amazon Resource Name (ARN) of the predictor
public DescribeAutoPredictorResult withPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor
predictorArn
- The Amazon Resource Name (ARN) of the predictorpublic void setPredictorName(String predictorName)
The name of the predictor.
predictorName
- The name of the predictor.public String getPredictorName()
The name of the predictor.
public DescribeAutoPredictorResult withPredictorName(String predictorName)
The name of the predictor.
predictorName
- The name of the predictor.public void setForecastHorizon(Integer forecastHorizon)
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
forecastHorizon
- The number of time-steps that the model predicts. The forecast horizon is also called the prediction
length.public Integer getForecastHorizon()
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
public DescribeAutoPredictorResult withForecastHorizon(Integer forecastHorizon)
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
forecastHorizon
- The number of time-steps that the model predicts. The forecast horizon is also called the prediction
length.public List<String> getForecastTypes()
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
public void setForecastTypes(Collection<String> forecastTypes)
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
forecastTypes
- The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].public DescribeAutoPredictorResult withForecastTypes(String... forecastTypes)
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
NOTE: This method appends the values to the existing list (if any). Use
setForecastTypes(java.util.Collection)
or withForecastTypes(java.util.Collection)
if you want
to override the existing values.
forecastTypes
- The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].public DescribeAutoPredictorResult withForecastTypes(Collection<String> forecastTypes)
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
forecastTypes
- The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].public void setForecastFrequency(String forecastFrequency)
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
forecastFrequency
- The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
public String getForecastFrequency()
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
public DescribeAutoPredictorResult withForecastFrequency(String forecastFrequency)
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
forecastFrequency
- The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
public List<String> getForecastDimensions()
An array of dimension (field) names that specify the attributes used to group your time series.
public void setForecastDimensions(Collection<String> forecastDimensions)
An array of dimension (field) names that specify the attributes used to group your time series.
forecastDimensions
- An array of dimension (field) names that specify the attributes used to group your time series.public DescribeAutoPredictorResult withForecastDimensions(String... forecastDimensions)
An array of dimension (field) names that specify the attributes used to group your time series.
NOTE: This method appends the values to the existing list (if any). Use
setForecastDimensions(java.util.Collection)
or withForecastDimensions(java.util.Collection)
if
you want to override the existing values.
forecastDimensions
- An array of dimension (field) names that specify the attributes used to group your time series.public DescribeAutoPredictorResult withForecastDimensions(Collection<String> forecastDimensions)
An array of dimension (field) names that specify the attributes used to group your time series.
forecastDimensions
- An array of dimension (field) names that specify the attributes used to group your time series.public List<String> getDatasetImportJobArns()
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
public void setDatasetImportJobArns(Collection<String> datasetImportJobArns)
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
datasetImportJobArns
- An array of the ARNs of the dataset import jobs used to import training data for the predictor.public DescribeAutoPredictorResult withDatasetImportJobArns(String... datasetImportJobArns)
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
NOTE: This method appends the values to the existing list (if any). Use
setDatasetImportJobArns(java.util.Collection)
or withDatasetImportJobArns(java.util.Collection)
if you want to override the existing values.
datasetImportJobArns
- An array of the ARNs of the dataset import jobs used to import training data for the predictor.public DescribeAutoPredictorResult withDatasetImportJobArns(Collection<String> datasetImportJobArns)
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
datasetImportJobArns
- An array of the ARNs of the dataset import jobs used to import training data for the predictor.public void setDataConfig(DataConfig dataConfig)
The data configuration for your dataset group and any additional datasets.
dataConfig
- The data configuration for your dataset group and any additional datasets.public DataConfig getDataConfig()
The data configuration for your dataset group and any additional datasets.
public DescribeAutoPredictorResult withDataConfig(DataConfig dataConfig)
The data configuration for your dataset group and any additional datasets.
dataConfig
- The data configuration for your dataset group and any additional datasets.public void setEncryptionConfig(EncryptionConfig encryptionConfig)
encryptionConfig
- public EncryptionConfig getEncryptionConfig()
public DescribeAutoPredictorResult withEncryptionConfig(EncryptionConfig encryptionConfig)
encryptionConfig
- public void setReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary)
The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
referencePredictorSummary
- The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded
predictors.public ReferencePredictorSummary getReferencePredictorSummary()
The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
public DescribeAutoPredictorResult withReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary)
The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
referencePredictorSummary
- The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded
predictors.public void setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
The estimated time remaining in minutes for the predictor training job to complete.
estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the predictor training job to complete.public Long getEstimatedTimeRemainingInMinutes()
The estimated time remaining in minutes for the predictor training job to complete.
public DescribeAutoPredictorResult withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
The estimated time remaining in minutes for the predictor training job to complete.
estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the predictor training job to complete.public void setStatus(String status)
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
status
- The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
public String getStatus()
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
public DescribeAutoPredictorResult withStatus(String status)
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
status
- The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
public void setMessage(String message)
In the event of an error, a message detailing the cause of the error.
message
- In the event of an error, a message detailing the cause of the error.public String getMessage()
In the event of an error, a message detailing the cause of the error.
public DescribeAutoPredictorResult withMessage(String message)
In the event of an error, a message detailing the cause of the error.
message
- In the event of an error, a message detailing the cause of the error.public void setCreationTime(Date creationTime)
The timestamp of the CreateAutoPredictor request.
creationTime
- The timestamp of the CreateAutoPredictor request.public Date getCreationTime()
The timestamp of the CreateAutoPredictor request.
public DescribeAutoPredictorResult withCreationTime(Date creationTime)
The timestamp of the CreateAutoPredictor request.
creationTime
- The timestamp of the CreateAutoPredictor request.public void setLastModificationTime(Date lastModificationTime)
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
lastModificationTime
- The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
public Date getLastModificationTime()
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
public DescribeAutoPredictorResult withLastModificationTime(Date lastModificationTime)
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
lastModificationTime
- The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
public void setOptimizationMetric(String optimizationMetric)
The accuracy metric used to optimize the predictor.
optimizationMetric
- The accuracy metric used to optimize the predictor.OptimizationMetric
public String getOptimizationMetric()
The accuracy metric used to optimize the predictor.
OptimizationMetric
public DescribeAutoPredictorResult withOptimizationMetric(String optimizationMetric)
The accuracy metric used to optimize the predictor.
optimizationMetric
- The accuracy metric used to optimize the predictor.OptimizationMetric
public DescribeAutoPredictorResult withOptimizationMetric(OptimizationMetric optimizationMetric)
The accuracy metric used to optimize the predictor.
optimizationMetric
- The accuracy metric used to optimize the predictor.OptimizationMetric
public void setExplainabilityInfo(ExplainabilityInfo explainabilityInfo)
Provides the status and ARN of the Predictor Explainability.
explainabilityInfo
- Provides the status and ARN of the Predictor Explainability.public ExplainabilityInfo getExplainabilityInfo()
Provides the status and ARN of the Predictor Explainability.
public DescribeAutoPredictorResult withExplainabilityInfo(ExplainabilityInfo explainabilityInfo)
Provides the status and ARN of the Predictor Explainability.
explainabilityInfo
- Provides the status and ARN of the Predictor Explainability.public void setMonitorInfo(MonitorInfo monitorInfo)
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
monitorInfo
- A object with the Amazon Resource Name (ARN) and status of the monitor resource.public MonitorInfo getMonitorInfo()
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
public DescribeAutoPredictorResult withMonitorInfo(MonitorInfo monitorInfo)
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
monitorInfo
- A object with the Amazon Resource Name (ARN) and status of the monitor resource.public void setTimeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary)
The time boundary Forecast uses when aggregating data.
timeAlignmentBoundary
- The time boundary Forecast uses when aggregating data.public TimeAlignmentBoundary getTimeAlignmentBoundary()
The time boundary Forecast uses when aggregating data.
public DescribeAutoPredictorResult withTimeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary)
The time boundary Forecast uses when aggregating data.
timeAlignmentBoundary
- The time boundary Forecast uses when aggregating data.public String toString()
toString
in class Object
Object.toString()
public DescribeAutoPredictorResult clone()