com.amazonaws.services.forecast.model.DescribeAutoPredictorResult Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.forecast.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAutoPredictorResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the predictor
*
*/
private String predictorArn;
/**
*
* The name of the predictor.
*
*/
private String predictorName;
/**
*
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
*
*/
private Integer forecastHorizon;
/**
*
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
*
*/
private java.util.List forecastTypes;
/**
*
* 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.
*
*/
private String forecastFrequency;
/**
*
* An array of dimension (field) names that specify the attributes used to group your time series.
*
*/
private java.util.List forecastDimensions;
/**
*
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
*
*/
private java.util.List datasetImportJobArns;
/**
*
* The data configuration for your dataset group and any additional datasets.
*
*/
private DataConfig dataConfig;
private EncryptionConfig encryptionConfig;
/**
*
* The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
*
*/
private ReferencePredictorSummary referencePredictorSummary;
/**
*
* The estimated time remaining in minutes for the predictor training job to complete.
*
*/
private Long estimatedTimeRemainingInMinutes;
/**
*
* 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
*
*
*
*/
private String status;
/**
*
* In the event of an error, a message detailing the cause of the error.
*
*/
private String message;
/**
*
* The timestamp of the CreateAutoPredictor request.
*
*/
private java.util.Date creationTime;
/**
*
* 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.
*
*
*
*/
private java.util.Date lastModificationTime;
/**
*
* The accuracy metric used to optimize the predictor.
*
*/
private String optimizationMetric;
/**
*
* Provides the status and ARN of the Predictor Explainability.
*
*/
private ExplainabilityInfo explainabilityInfo;
/**
*
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
*
*/
private MonitorInfo monitorInfo;
/**
*
* The time boundary Forecast uses when aggregating data.
*
*/
private TimeAlignmentBoundary timeAlignmentBoundary;
/**
*
* The Amazon Resource Name (ARN) of the predictor
*
*
* @param predictorArn
* The Amazon Resource Name (ARN) of the predictor
*/
public void setPredictorArn(String predictorArn) {
this.predictorArn = predictorArn;
}
/**
*
* The Amazon Resource Name (ARN) of the predictor
*
*
* @return The Amazon Resource Name (ARN) of the predictor
*/
public String getPredictorArn() {
return this.predictorArn;
}
/**
*
* The Amazon Resource Name (ARN) of the predictor
*
*
* @param predictorArn
* The Amazon Resource Name (ARN) of the predictor
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withPredictorArn(String predictorArn) {
setPredictorArn(predictorArn);
return this;
}
/**
*
* The name of the predictor.
*
*
* @param predictorName
* The name of the predictor.
*/
public void setPredictorName(String predictorName) {
this.predictorName = predictorName;
}
/**
*
* The name of the predictor.
*
*
* @return The name of the predictor.
*/
public String getPredictorName() {
return this.predictorName;
}
/**
*
* The name of the predictor.
*
*
* @param predictorName
* The name of the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withPredictorName(String predictorName) {
setPredictorName(predictorName);
return this;
}
/**
*
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
*
*
* @param forecastHorizon
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction
* length.
*/
public void setForecastHorizon(Integer forecastHorizon) {
this.forecastHorizon = forecastHorizon;
}
/**
*
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
*
*
* @return The number of time-steps that the model predicts. The forecast horizon is also called the prediction
* length.
*/
public Integer getForecastHorizon() {
return this.forecastHorizon;
}
/**
*
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
*
*
* @param forecastHorizon
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction
* length.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withForecastHorizon(Integer forecastHorizon) {
setForecastHorizon(forecastHorizon);
return this;
}
/**
*
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
*
*
* @return The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
*/
public java.util.List getForecastTypes() {
return forecastTypes;
}
/**
*
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
*
*
* @param forecastTypes
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
*/
public void setForecastTypes(java.util.Collection forecastTypes) {
if (forecastTypes == null) {
this.forecastTypes = null;
return;
}
this.forecastTypes = new java.util.ArrayList(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
* {@link #setForecastTypes(java.util.Collection)} or {@link #withForecastTypes(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param forecastTypes
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withForecastTypes(String... forecastTypes) {
if (this.forecastTypes == null) {
setForecastTypes(new java.util.ArrayList(forecastTypes.length));
}
for (String ele : forecastTypes) {
this.forecastTypes.add(ele);
}
return this;
}
/**
*
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
*
*
* @param forecastTypes
* The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withForecastTypes(java.util.Collection forecastTypes) {
setForecastTypes(forecastTypes);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setForecastFrequency(String forecastFrequency) {
this.forecastFrequency = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withForecastFrequency(String forecastFrequency) {
setForecastFrequency(forecastFrequency);
return this;
}
/**
*
* An array of dimension (field) names that specify the attributes used to group your time series.
*
*
* @return An array of dimension (field) names that specify the attributes used to group your time series.
*/
public java.util.List getForecastDimensions() {
return forecastDimensions;
}
/**
*
* An array of dimension (field) names that specify the attributes used to group your time series.
*
*
* @param forecastDimensions
* An array of dimension (field) names that specify the attributes used to group your time series.
*/
public void setForecastDimensions(java.util.Collection forecastDimensions) {
if (forecastDimensions == null) {
this.forecastDimensions = null;
return;
}
this.forecastDimensions = new java.util.ArrayList(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
* {@link #setForecastDimensions(java.util.Collection)} or {@link #withForecastDimensions(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param forecastDimensions
* An array of dimension (field) names that specify the attributes used to group your time series.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withForecastDimensions(String... forecastDimensions) {
if (this.forecastDimensions == null) {
setForecastDimensions(new java.util.ArrayList(forecastDimensions.length));
}
for (String ele : forecastDimensions) {
this.forecastDimensions.add(ele);
}
return this;
}
/**
*
* An array of dimension (field) names that specify the attributes used to group your time series.
*
*
* @param forecastDimensions
* An array of dimension (field) names that specify the attributes used to group your time series.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withForecastDimensions(java.util.Collection forecastDimensions) {
setForecastDimensions(forecastDimensions);
return this;
}
/**
*
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
*
*
* @return An array of the ARNs of the dataset import jobs used to import training data for the predictor.
*/
public java.util.List getDatasetImportJobArns() {
return datasetImportJobArns;
}
/**
*
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
*
*
* @param datasetImportJobArns
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
*/
public void setDatasetImportJobArns(java.util.Collection datasetImportJobArns) {
if (datasetImportJobArns == null) {
this.datasetImportJobArns = null;
return;
}
this.datasetImportJobArns = new java.util.ArrayList(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
* {@link #setDatasetImportJobArns(java.util.Collection)} or {@link #withDatasetImportJobArns(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param datasetImportJobArns
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withDatasetImportJobArns(String... datasetImportJobArns) {
if (this.datasetImportJobArns == null) {
setDatasetImportJobArns(new java.util.ArrayList(datasetImportJobArns.length));
}
for (String ele : datasetImportJobArns) {
this.datasetImportJobArns.add(ele);
}
return this;
}
/**
*
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
*
*
* @param datasetImportJobArns
* An array of the ARNs of the dataset import jobs used to import training data for the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withDatasetImportJobArns(java.util.Collection datasetImportJobArns) {
setDatasetImportJobArns(datasetImportJobArns);
return this;
}
/**
*
* The data configuration for your dataset group and any additional datasets.
*
*
* @param dataConfig
* The data configuration for your dataset group and any additional datasets.
*/
public void setDataConfig(DataConfig dataConfig) {
this.dataConfig = dataConfig;
}
/**
*
* The data configuration for your dataset group and any additional datasets.
*
*
* @return The data configuration for your dataset group and any additional datasets.
*/
public DataConfig getDataConfig() {
return this.dataConfig;
}
/**
*
* The data configuration for your dataset group and any additional datasets.
*
*
* @param dataConfig
* The data configuration for your dataset group and any additional datasets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withDataConfig(DataConfig dataConfig) {
setDataConfig(dataConfig);
return this;
}
/**
* @param encryptionConfig
*/
public void setEncryptionConfig(EncryptionConfig encryptionConfig) {
this.encryptionConfig = encryptionConfig;
}
/**
* @return
*/
public EncryptionConfig getEncryptionConfig() {
return this.encryptionConfig;
}
/**
* @param encryptionConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withEncryptionConfig(EncryptionConfig encryptionConfig) {
setEncryptionConfig(encryptionConfig);
return this;
}
/**
*
* The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
*
*
* @param referencePredictorSummary
* The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded
* predictors.
*/
public void setReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary) {
this.referencePredictorSummary = referencePredictorSummary;
}
/**
*
* The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
*
*
* @return The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded
* predictors.
*/
public ReferencePredictorSummary getReferencePredictorSummary() {
return this.referencePredictorSummary;
}
/**
*
* The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
*
*
* @param referencePredictorSummary
* The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded
* predictors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary) {
setReferencePredictorSummary(referencePredictorSummary);
return this;
}
/**
*
* The estimated time remaining in minutes for the predictor training job to complete.
*
*
* @param estimatedTimeRemainingInMinutes
* The estimated time remaining in minutes for the predictor training job to complete.
*/
public void setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes) {
this.estimatedTimeRemainingInMinutes = estimatedTimeRemainingInMinutes;
}
/**
*
* The estimated time remaining in minutes for the predictor training job to complete.
*
*
* @return The estimated time remaining in minutes for the predictor training job to complete.
*/
public Long getEstimatedTimeRemainingInMinutes() {
return this.estimatedTimeRemainingInMinutes;
}
/**
*
* The estimated time remaining in minutes for the predictor training job to complete.
*
*
* @param estimatedTimeRemainingInMinutes
* The estimated time remaining in minutes for the predictor training job to complete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes) {
setEstimatedTimeRemainingInMinutes(estimatedTimeRemainingInMinutes);
return this;
}
/**
*
* 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
*
*
*
*
* @param 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 setStatus(String status) {
this.status = 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
*
*
*
*
* @return 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() {
return this.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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* In the event of an error, a message detailing the cause of the error.
*
*
* @param message
* In the event of an error, a message detailing the cause of the error.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* In the event of an error, a message detailing the cause of the error.
*
*
* @return In the event of an error, a message detailing the cause of the error.
*/
public String getMessage() {
return this.message;
}
/**
*
* In the event of an error, a message detailing the cause of the error.
*
*
* @param message
* In the event of an error, a message detailing the cause of the error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withMessage(String message) {
setMessage(message);
return this;
}
/**
*
* The timestamp of the CreateAutoPredictor request.
*
*
* @param creationTime
* The timestamp of the CreateAutoPredictor request.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The timestamp of the CreateAutoPredictor request.
*
*
* @return The timestamp of the CreateAutoPredictor request.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The timestamp of the CreateAutoPredictor request.
*
*
* @param creationTime
* The timestamp of the CreateAutoPredictor request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setLastModificationTime(java.util.Date lastModificationTime) {
this.lastModificationTime = 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.
*
*
*
*
* @return 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 java.util.Date getLastModificationTime() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withLastModificationTime(java.util.Date lastModificationTime) {
setLastModificationTime(lastModificationTime);
return this;
}
/**
*
* The accuracy metric used to optimize the predictor.
*
*
* @param optimizationMetric
* The accuracy metric used to optimize the predictor.
* @see OptimizationMetric
*/
public void setOptimizationMetric(String optimizationMetric) {
this.optimizationMetric = optimizationMetric;
}
/**
*
* The accuracy metric used to optimize the predictor.
*
*
* @return The accuracy metric used to optimize the predictor.
* @see OptimizationMetric
*/
public String getOptimizationMetric() {
return this.optimizationMetric;
}
/**
*
* The accuracy metric used to optimize the predictor.
*
*
* @param optimizationMetric
* The accuracy metric used to optimize the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OptimizationMetric
*/
public DescribeAutoPredictorResult withOptimizationMetric(String optimizationMetric) {
setOptimizationMetric(optimizationMetric);
return this;
}
/**
*
* The accuracy metric used to optimize the predictor.
*
*
* @param optimizationMetric
* The accuracy metric used to optimize the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OptimizationMetric
*/
public DescribeAutoPredictorResult withOptimizationMetric(OptimizationMetric optimizationMetric) {
this.optimizationMetric = optimizationMetric.toString();
return this;
}
/**
*
* Provides the status and ARN of the Predictor Explainability.
*
*
* @param explainabilityInfo
* Provides the status and ARN of the Predictor Explainability.
*/
public void setExplainabilityInfo(ExplainabilityInfo explainabilityInfo) {
this.explainabilityInfo = explainabilityInfo;
}
/**
*
* Provides the status and ARN of the Predictor Explainability.
*
*
* @return Provides the status and ARN of the Predictor Explainability.
*/
public ExplainabilityInfo getExplainabilityInfo() {
return this.explainabilityInfo;
}
/**
*
* Provides the status and ARN of the Predictor Explainability.
*
*
* @param explainabilityInfo
* Provides the status and ARN of the Predictor Explainability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withExplainabilityInfo(ExplainabilityInfo explainabilityInfo) {
setExplainabilityInfo(explainabilityInfo);
return this;
}
/**
*
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
*
*
* @param monitorInfo
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
*/
public void setMonitorInfo(MonitorInfo monitorInfo) {
this.monitorInfo = monitorInfo;
}
/**
*
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
*
*
* @return A object with the Amazon Resource Name (ARN) and status of the monitor resource.
*/
public MonitorInfo getMonitorInfo() {
return this.monitorInfo;
}
/**
*
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
*
*
* @param monitorInfo
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withMonitorInfo(MonitorInfo monitorInfo) {
setMonitorInfo(monitorInfo);
return this;
}
/**
*
* The time boundary Forecast uses when aggregating data.
*
*
* @param timeAlignmentBoundary
* The time boundary Forecast uses when aggregating data.
*/
public void setTimeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary) {
this.timeAlignmentBoundary = timeAlignmentBoundary;
}
/**
*
* The time boundary Forecast uses when aggregating data.
*
*
* @return The time boundary Forecast uses when aggregating data.
*/
public TimeAlignmentBoundary getTimeAlignmentBoundary() {
return this.timeAlignmentBoundary;
}
/**
*
* The time boundary Forecast uses when aggregating data.
*
*
* @param timeAlignmentBoundary
* The time boundary Forecast uses when aggregating data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAutoPredictorResult withTimeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary) {
setTimeAlignmentBoundary(timeAlignmentBoundary);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPredictorArn() != null)
sb.append("PredictorArn: ").append(getPredictorArn()).append(",");
if (getPredictorName() != null)
sb.append("PredictorName: ").append(getPredictorName()).append(",");
if (getForecastHorizon() != null)
sb.append("ForecastHorizon: ").append(getForecastHorizon()).append(",");
if (getForecastTypes() != null)
sb.append("ForecastTypes: ").append(getForecastTypes()).append(",");
if (getForecastFrequency() != null)
sb.append("ForecastFrequency: ").append(getForecastFrequency()).append(",");
if (getForecastDimensions() != null)
sb.append("ForecastDimensions: ").append(getForecastDimensions()).append(",");
if (getDatasetImportJobArns() != null)
sb.append("DatasetImportJobArns: ").append(getDatasetImportJobArns()).append(",");
if (getDataConfig() != null)
sb.append("DataConfig: ").append(getDataConfig()).append(",");
if (getEncryptionConfig() != null)
sb.append("EncryptionConfig: ").append(getEncryptionConfig()).append(",");
if (getReferencePredictorSummary() != null)
sb.append("ReferencePredictorSummary: ").append(getReferencePredictorSummary()).append(",");
if (getEstimatedTimeRemainingInMinutes() != null)
sb.append("EstimatedTimeRemainingInMinutes: ").append(getEstimatedTimeRemainingInMinutes()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getMessage() != null)
sb.append("Message: ").append(getMessage()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastModificationTime() != null)
sb.append("LastModificationTime: ").append(getLastModificationTime()).append(",");
if (getOptimizationMetric() != null)
sb.append("OptimizationMetric: ").append(getOptimizationMetric()).append(",");
if (getExplainabilityInfo() != null)
sb.append("ExplainabilityInfo: ").append(getExplainabilityInfo()).append(",");
if (getMonitorInfo() != null)
sb.append("MonitorInfo: ").append(getMonitorInfo()).append(",");
if (getTimeAlignmentBoundary() != null)
sb.append("TimeAlignmentBoundary: ").append(getTimeAlignmentBoundary());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeAutoPredictorResult == false)
return false;
DescribeAutoPredictorResult other = (DescribeAutoPredictorResult) obj;
if (other.getPredictorArn() == null ^ this.getPredictorArn() == null)
return false;
if (other.getPredictorArn() != null && other.getPredictorArn().equals(this.getPredictorArn()) == false)
return false;
if (other.getPredictorName() == null ^ this.getPredictorName() == null)
return false;
if (other.getPredictorName() != null && other.getPredictorName().equals(this.getPredictorName()) == false)
return false;
if (other.getForecastHorizon() == null ^ this.getForecastHorizon() == null)
return false;
if (other.getForecastHorizon() != null && other.getForecastHorizon().equals(this.getForecastHorizon()) == false)
return false;
if (other.getForecastTypes() == null ^ this.getForecastTypes() == null)
return false;
if (other.getForecastTypes() != null && other.getForecastTypes().equals(this.getForecastTypes()) == false)
return false;
if (other.getForecastFrequency() == null ^ this.getForecastFrequency() == null)
return false;
if (other.getForecastFrequency() != null && other.getForecastFrequency().equals(this.getForecastFrequency()) == false)
return false;
if (other.getForecastDimensions() == null ^ this.getForecastDimensions() == null)
return false;
if (other.getForecastDimensions() != null && other.getForecastDimensions().equals(this.getForecastDimensions()) == false)
return false;
if (other.getDatasetImportJobArns() == null ^ this.getDatasetImportJobArns() == null)
return false;
if (other.getDatasetImportJobArns() != null && other.getDatasetImportJobArns().equals(this.getDatasetImportJobArns()) == false)
return false;
if (other.getDataConfig() == null ^ this.getDataConfig() == null)
return false;
if (other.getDataConfig() != null && other.getDataConfig().equals(this.getDataConfig()) == false)
return false;
if (other.getEncryptionConfig() == null ^ this.getEncryptionConfig() == null)
return false;
if (other.getEncryptionConfig() != null && other.getEncryptionConfig().equals(this.getEncryptionConfig()) == false)
return false;
if (other.getReferencePredictorSummary() == null ^ this.getReferencePredictorSummary() == null)
return false;
if (other.getReferencePredictorSummary() != null && other.getReferencePredictorSummary().equals(this.getReferencePredictorSummary()) == false)
return false;
if (other.getEstimatedTimeRemainingInMinutes() == null ^ this.getEstimatedTimeRemainingInMinutes() == null)
return false;
if (other.getEstimatedTimeRemainingInMinutes() != null
&& other.getEstimatedTimeRemainingInMinutes().equals(this.getEstimatedTimeRemainingInMinutes()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getLastModificationTime() == null ^ this.getLastModificationTime() == null)
return false;
if (other.getLastModificationTime() != null && other.getLastModificationTime().equals(this.getLastModificationTime()) == false)
return false;
if (other.getOptimizationMetric() == null ^ this.getOptimizationMetric() == null)
return false;
if (other.getOptimizationMetric() != null && other.getOptimizationMetric().equals(this.getOptimizationMetric()) == false)
return false;
if (other.getExplainabilityInfo() == null ^ this.getExplainabilityInfo() == null)
return false;
if (other.getExplainabilityInfo() != null && other.getExplainabilityInfo().equals(this.getExplainabilityInfo()) == false)
return false;
if (other.getMonitorInfo() == null ^ this.getMonitorInfo() == null)
return false;
if (other.getMonitorInfo() != null && other.getMonitorInfo().equals(this.getMonitorInfo()) == false)
return false;
if (other.getTimeAlignmentBoundary() == null ^ this.getTimeAlignmentBoundary() == null)
return false;
if (other.getTimeAlignmentBoundary() != null && other.getTimeAlignmentBoundary().equals(this.getTimeAlignmentBoundary()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPredictorArn() == null) ? 0 : getPredictorArn().hashCode());
hashCode = prime * hashCode + ((getPredictorName() == null) ? 0 : getPredictorName().hashCode());
hashCode = prime * hashCode + ((getForecastHorizon() == null) ? 0 : getForecastHorizon().hashCode());
hashCode = prime * hashCode + ((getForecastTypes() == null) ? 0 : getForecastTypes().hashCode());
hashCode = prime * hashCode + ((getForecastFrequency() == null) ? 0 : getForecastFrequency().hashCode());
hashCode = prime * hashCode + ((getForecastDimensions() == null) ? 0 : getForecastDimensions().hashCode());
hashCode = prime * hashCode + ((getDatasetImportJobArns() == null) ? 0 : getDatasetImportJobArns().hashCode());
hashCode = prime * hashCode + ((getDataConfig() == null) ? 0 : getDataConfig().hashCode());
hashCode = prime * hashCode + ((getEncryptionConfig() == null) ? 0 : getEncryptionConfig().hashCode());
hashCode = prime * hashCode + ((getReferencePredictorSummary() == null) ? 0 : getReferencePredictorSummary().hashCode());
hashCode = prime * hashCode + ((getEstimatedTimeRemainingInMinutes() == null) ? 0 : getEstimatedTimeRemainingInMinutes().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastModificationTime() == null) ? 0 : getLastModificationTime().hashCode());
hashCode = prime * hashCode + ((getOptimizationMetric() == null) ? 0 : getOptimizationMetric().hashCode());
hashCode = prime * hashCode + ((getExplainabilityInfo() == null) ? 0 : getExplainabilityInfo().hashCode());
hashCode = prime * hashCode + ((getMonitorInfo() == null) ? 0 : getMonitorInfo().hashCode());
hashCode = prime * hashCode + ((getTimeAlignmentBoundary() == null) ? 0 : getTimeAlignmentBoundary().hashCode());
return hashCode;
}
@Override
public DescribeAutoPredictorResult clone() {
try {
return (DescribeAutoPredictorResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}