com.amazonaws.services.forecast.model.DescribeForecastResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-forecast Show documentation
/*
* Copyright 2015-2020 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 DescribeForecastResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The forecast ARN as specified in the request.
*
*/
private String forecastArn;
/**
*
* The name of the forecast.
*
*/
private String forecastName;
/**
*
* The quantiles at which proababilistic forecasts were generated.
*
*/
private java.util.List forecastTypes;
/**
*
* The ARN of the predictor used to generate the forecast.
*
*/
private String predictorArn;
/**
*
* The ARN of the dataset group that provided the data used to train the predictor.
*
*/
private String datasetGroupArn;
/**
*
* The status of the forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the forecast.
*
*
*/
private String status;
/**
*
* If an error occurred, an informational message about the error.
*
*/
private String message;
/**
*
* When the forecast creation task was created.
*
*/
private java.util.Date creationTime;
/**
*
* Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
* (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
* complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
*
*/
private java.util.Date lastModificationTime;
/**
*
* The forecast ARN as specified in the request.
*
*
* @param forecastArn
* The forecast ARN as specified in the request.
*/
public void setForecastArn(String forecastArn) {
this.forecastArn = forecastArn;
}
/**
*
* The forecast ARN as specified in the request.
*
*
* @return The forecast ARN as specified in the request.
*/
public String getForecastArn() {
return this.forecastArn;
}
/**
*
* The forecast ARN as specified in the request.
*
*
* @param forecastArn
* The forecast ARN as specified in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withForecastArn(String forecastArn) {
setForecastArn(forecastArn);
return this;
}
/**
*
* The name of the forecast.
*
*
* @param forecastName
* The name of the forecast.
*/
public void setForecastName(String forecastName) {
this.forecastName = forecastName;
}
/**
*
* The name of the forecast.
*
*
* @return The name of the forecast.
*/
public String getForecastName() {
return this.forecastName;
}
/**
*
* The name of the forecast.
*
*
* @param forecastName
* The name of the forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withForecastName(String forecastName) {
setForecastName(forecastName);
return this;
}
/**
*
* The quantiles at which proababilistic forecasts were generated.
*
*
* @return The quantiles at which proababilistic forecasts were generated.
*/
public java.util.List getForecastTypes() {
return forecastTypes;
}
/**
*
* The quantiles at which proababilistic forecasts were generated.
*
*
* @param forecastTypes
* The quantiles at which proababilistic forecasts were generated.
*/
public void setForecastTypes(java.util.Collection forecastTypes) {
if (forecastTypes == null) {
this.forecastTypes = null;
return;
}
this.forecastTypes = new java.util.ArrayList(forecastTypes);
}
/**
*
* The quantiles at which proababilistic forecasts were generated.
*
*
* 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 quantiles at which proababilistic forecasts were generated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult 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 quantiles at which proababilistic forecasts were generated.
*
*
* @param forecastTypes
* The quantiles at which proababilistic forecasts were generated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withForecastTypes(java.util.Collection forecastTypes) {
setForecastTypes(forecastTypes);
return this;
}
/**
*
* The ARN of the predictor used to generate the forecast.
*
*
* @param predictorArn
* The ARN of the predictor used to generate the forecast.
*/
public void setPredictorArn(String predictorArn) {
this.predictorArn = predictorArn;
}
/**
*
* The ARN of the predictor used to generate the forecast.
*
*
* @return The ARN of the predictor used to generate the forecast.
*/
public String getPredictorArn() {
return this.predictorArn;
}
/**
*
* The ARN of the predictor used to generate the forecast.
*
*
* @param predictorArn
* The ARN of the predictor used to generate the forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withPredictorArn(String predictorArn) {
setPredictorArn(predictorArn);
return this;
}
/**
*
* The ARN of the dataset group that provided the data used to train the predictor.
*
*
* @param datasetGroupArn
* The ARN of the dataset group that provided the data used to train the predictor.
*/
public void setDatasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
}
/**
*
* The ARN of the dataset group that provided the data used to train the predictor.
*
*
* @return The ARN of the dataset group that provided the data used to train the predictor.
*/
public String getDatasetGroupArn() {
return this.datasetGroupArn;
}
/**
*
* The ARN of the dataset group that provided the data used to train the predictor.
*
*
* @param datasetGroupArn
* The ARN of the dataset group that provided the data used to train the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withDatasetGroupArn(String datasetGroupArn) {
setDatasetGroupArn(datasetGroupArn);
return this;
}
/**
*
* The status of the forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the forecast.
*
*
*
* @param status
* The status of the forecast. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the
* forecast.
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the forecast.
*
*
*
* @return The status of the forecast. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the
* forecast.
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the forecast.
*
*
*
* @param status
* The status of the forecast. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the
* forecast.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @param message
* If an error occurred, an informational message about the error.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @return If an error occurred, an informational message about the error.
*/
public String getMessage() {
return this.message;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @param message
* If an error occurred, an informational message about the error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withMessage(String message) {
setMessage(message);
return this;
}
/**
*
* When the forecast creation task was created.
*
*
* @param creationTime
* When the forecast creation task was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the forecast creation task was created.
*
*
* @return When the forecast creation task was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the forecast creation task was created.
*
*
* @param creationTime
* When the forecast creation task was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
* (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
* complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
*
*
* @param lastModificationTime
* Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
* inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when
* inference is complete (status changed to ACTIVE) or fails (status changed to
* CREATE_FAILED).
*/
public void setLastModificationTime(java.util.Date lastModificationTime) {
this.lastModificationTime = lastModificationTime;
}
/**
*
* Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
* (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
* complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
*
*
* @return Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
* inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when
* inference is complete (status changed to ACTIVE) or fails (status changed to
* CREATE_FAILED).
*/
public java.util.Date getLastModificationTime() {
return this.lastModificationTime;
}
/**
*
* Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
* (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
* complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
*
*
* @param lastModificationTime
* Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
* inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when
* inference is complete (status changed to ACTIVE) or fails (status changed to
* CREATE_FAILED).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeForecastResult withLastModificationTime(java.util.Date lastModificationTime) {
setLastModificationTime(lastModificationTime);
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 (getForecastArn() != null)
sb.append("ForecastArn: ").append(getForecastArn()).append(",");
if (getForecastName() != null)
sb.append("ForecastName: ").append(getForecastName()).append(",");
if (getForecastTypes() != null)
sb.append("ForecastTypes: ").append(getForecastTypes()).append(",");
if (getPredictorArn() != null)
sb.append("PredictorArn: ").append(getPredictorArn()).append(",");
if (getDatasetGroupArn() != null)
sb.append("DatasetGroupArn: ").append(getDatasetGroupArn()).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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeForecastResult == false)
return false;
DescribeForecastResult other = (DescribeForecastResult) obj;
if (other.getForecastArn() == null ^ this.getForecastArn() == null)
return false;
if (other.getForecastArn() != null && other.getForecastArn().equals(this.getForecastArn()) == false)
return false;
if (other.getForecastName() == null ^ this.getForecastName() == null)
return false;
if (other.getForecastName() != null && other.getForecastName().equals(this.getForecastName()) == 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.getPredictorArn() == null ^ this.getPredictorArn() == null)
return false;
if (other.getPredictorArn() != null && other.getPredictorArn().equals(this.getPredictorArn()) == false)
return false;
if (other.getDatasetGroupArn() == null ^ this.getDatasetGroupArn() == null)
return false;
if (other.getDatasetGroupArn() != null && other.getDatasetGroupArn().equals(this.getDatasetGroupArn()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getForecastArn() == null) ? 0 : getForecastArn().hashCode());
hashCode = prime * hashCode + ((getForecastName() == null) ? 0 : getForecastName().hashCode());
hashCode = prime * hashCode + ((getForecastTypes() == null) ? 0 : getForecastTypes().hashCode());
hashCode = prime * hashCode + ((getPredictorArn() == null) ? 0 : getPredictorArn().hashCode());
hashCode = prime * hashCode + ((getDatasetGroupArn() == null) ? 0 : getDatasetGroupArn().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());
return hashCode;
}
@Override
public DescribeForecastResult clone() {
try {
return (DescribeForecastResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}