DescribeForecastResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.forecast.model.DescribeForecastResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeForecastResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeForecastResult()

Constructors
Constructor and Description
`DescribeForecastResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeForecastResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the forecast creation task was created.
`String`	`getDatasetGroupArn()` The ARN of the dataset group that provided the data used to train the predictor.
`Long`	`getEstimatedTimeRemainingInMinutes()` The estimated time remaining in minutes for the forecast job to complete.
`String`	`getForecastArn()` The forecast ARN as specified in the request.
`String`	`getForecastName()` The name of the forecast.
`List<String>`	`getForecastTypes()` The quantiles at which probabilistic forecasts were generated.
`Date`	`getLastModificationTime()` The last time the resource was modified.
`String`	`getMessage()` If an error occurred, an informational message about the error.
`String`	`getPredictorArn()` The ARN of the predictor used to generate the forecast.
`String`	`getStatus()` The status of the forecast.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` When the forecast creation task was created.
`void`	`setDatasetGroupArn(String datasetGroupArn)` The ARN of the dataset group that provided the data used to train the predictor.
`void`	`setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The estimated time remaining in minutes for the forecast job to complete.
`void`	`setForecastArn(String forecastArn)` The forecast ARN as specified in the request.
`void`	`setForecastName(String forecastName)` The name of the forecast.
`void`	`setForecastTypes(Collection<String> forecastTypes)` The quantiles at which probabilistic forecasts were generated.
`void`	`setLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`void`	`setMessage(String message)` If an error occurred, an informational message about the error.
`void`	`setPredictorArn(String predictorArn)` The ARN of the predictor used to generate the forecast.
`void`	`setStatus(String status)` The status of the forecast.
`String`	`toString()` Returns a string representation of this object.
`DescribeForecastResult`	`withCreationTime(Date creationTime)` When the forecast creation task was created.
`DescribeForecastResult`	`withDatasetGroupArn(String datasetGroupArn)` The ARN of the dataset group that provided the data used to train the predictor.
`DescribeForecastResult`	`withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The estimated time remaining in minutes for the forecast job to complete.
`DescribeForecastResult`	`withForecastArn(String forecastArn)` The forecast ARN as specified in the request.
`DescribeForecastResult`	`withForecastName(String forecastName)` The name of the forecast.
`DescribeForecastResult`	`withForecastTypes(Collection<String> forecastTypes)` The quantiles at which probabilistic forecasts were generated.
`DescribeForecastResult`	`withForecastTypes(String... forecastTypes)` The quantiles at which probabilistic forecasts were generated.
`DescribeForecastResult`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`DescribeForecastResult`	`withMessage(String message)` If an error occurred, an informational message about the error.
`DescribeForecastResult`	`withPredictorArn(String predictorArn)` The ARN of the predictor used to generate the forecast.
`DescribeForecastResult`	`withStatus(String status)` The status of the forecast.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeForecastResult
```
public DescribeForecastResult()
```
- Method Detail
  - setForecastArn
```
public void setForecastArn(String forecastArn)
```
    The forecast ARN as specified in the request.
    
    Parameters:
    
    forecastArn - The forecast ARN as specified in the request.
  - getForecastArn
```
public String getForecastArn()
```
    The forecast ARN as specified in the request.
    
    Returns:
    
    The forecast ARN as specified in the request.
  - withForecastArn
```
public DescribeForecastResult withForecastArn(String forecastArn)
```
    The forecast ARN as specified in the request.
    
    Parameters:
    
    forecastArn - The forecast ARN as specified in the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setForecastName
```
public void setForecastName(String forecastName)
```
    The name of the forecast.
    
    Parameters:
    
    forecastName - The name of the forecast.
  - getForecastName
```
public String getForecastName()
```
    The name of the forecast.
    
    Returns:
    
    The name of the forecast.
  - withForecastName
```
public DescribeForecastResult withForecastName(String forecastName)
```
    The name of the forecast.
    
    Parameters:
    
    forecastName - The name of the forecast.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getForecastTypes
```
public List<String> getForecastTypes()
```
    The quantiles at which probabilistic forecasts were generated.
    
    Returns:
    
    The quantiles at which probabilistic forecasts were generated.
  - setForecastTypes
```
public void setForecastTypes(Collection<String> forecastTypes)
```
    The quantiles at which probabilistic forecasts were generated.
    
    Parameters:
    
    forecastTypes - The quantiles at which probabilistic forecasts were generated.
  - withForecastTypes
```
public DescribeForecastResult withForecastTypes(String... forecastTypes)
```
    The quantiles at which probabilistic forecasts were generated.
    
    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.
    
    Parameters:
    
    forecastTypes - The quantiles at which probabilistic forecasts were generated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withForecastTypes
```
public DescribeForecastResult withForecastTypes(Collection<String> forecastTypes)
```
    The quantiles at which probabilistic forecasts were generated.
    
    Parameters:
    
    forecastTypes - The quantiles at which probabilistic forecasts were generated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPredictorArn
```
public void setPredictorArn(String predictorArn)
```
    The ARN of the predictor used to generate the forecast.
    
    Parameters:
    
    predictorArn - The ARN of the predictor used to generate the forecast.
  - getPredictorArn
```
public String getPredictorArn()
```
    The ARN of the predictor used to generate the forecast.
    
    Returns:
    
    The ARN of the predictor used to generate the forecast.
  - withPredictorArn
```
public DescribeForecastResult withPredictorArn(String predictorArn)
```
    The ARN of the predictor used to generate the forecast.
    
    Parameters:
    
    predictorArn - The ARN of the predictor used to generate the forecast.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetGroupArn
```
public void setDatasetGroupArn(String datasetGroupArn)
```
    The ARN of the dataset group that provided the data used to train the predictor.
    
    Parameters:
    
    datasetGroupArn - The ARN of the dataset group that provided the data used to train the predictor.
  - getDatasetGroupArn
```
public String getDatasetGroupArn()
```
    The ARN of the dataset group that provided the data used to train the predictor.
    
    Returns:
    
    The ARN of the dataset group that provided the data used to train the predictor.
  - withDatasetGroupArn
```
public DescribeForecastResult withDatasetGroupArn(String datasetGroupArn)
```
    The ARN of the dataset group that provided the data used to train the predictor.
    
    Parameters:
    
    datasetGroupArn - The ARN of the dataset group that provided the data used to train the predictor.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEstimatedTimeRemainingInMinutes
```
public void setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The estimated time remaining in minutes for the forecast job to complete.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the forecast job to complete.
  - getEstimatedTimeRemainingInMinutes
```
public Long getEstimatedTimeRemainingInMinutes()
```
    The estimated time remaining in minutes for the forecast job to complete.
    
    Returns:
    
    The estimated time remaining in minutes for the forecast job to complete.
  - withEstimatedTimeRemainingInMinutes
```
public DescribeForecastResult withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The estimated time remaining in minutes for the forecast job to complete.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the forecast job to complete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the forecast. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
    Parameters:
    status - The status of the forecast. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
  - getStatus
```
public String getStatus()
```
    The status of the forecast. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
    Returns:
    The status of the forecast. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
  - withStatus
```
public DescribeForecastResult withStatus(String status)
```
    The status of the forecast. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - CREATE_STOPPING, CREATE_STOPPED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
    Parameters:
    status - The status of the forecast. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    CREATE_STOPPING, CREATE_STOPPED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessage
```
public void setMessage(String message)
```
    If an error occurred, an informational message about the error.
    
    Parameters:
    
    message - If an error occurred, an informational message about the error.
  - getMessage
```
public String getMessage()
```
    If an error occurred, an informational message about the error.
    
    Returns:
    
    If an error occurred, an informational message about the error.
  - withMessage
```
public DescribeForecastResult withMessage(String message)
```
    If an error occurred, an informational message about the error.
    
    Parameters:
    
    message - If an error occurred, an informational message about the error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    When the forecast creation task was created.
    
    Parameters:
    
    creationTime - When the forecast creation task was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the forecast creation task was created.
    
    Returns:
    
    When the forecast creation task was created.
  - withCreationTime
```
public DescribeForecastResult withCreationTime(Date creationTime)
```
    When the forecast creation task was created.
    
    Parameters:
    
    creationTime - When the forecast creation task was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModificationTime
```
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.
    Parameters:
    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.
  - getLastModificationTime
```
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.
    Returns:
    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.
  - withLastModificationTime
```
public DescribeForecastResult 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeForecastResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeForecastResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeForecastResult

Method Detail

setForecastArn

getForecastArn

withForecastArn

setForecastName

getForecastName

withForecastName

getForecastTypes

setForecastTypes

withForecastTypes

withForecastTypes

setPredictorArn

getPredictorArn

withPredictorArn

setDatasetGroupArn

getDatasetGroupArn

withDatasetGroupArn

setEstimatedTimeRemainingInMinutes

getEstimatedTimeRemainingInMinutes

withEstimatedTimeRemainingInMinutes

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone