ForecastSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.forecast.model.ForecastSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ForecastSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ForecastSummary()

Constructors
Constructor and Description
`ForecastSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ForecastSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the forecast creation task was created.
`String`	`getDatasetGroupArn()` The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
`String`	`getForecastArn()` The ARN of the forecast.
`String`	`getForecastName()` The name of the forecast.
`Date`	`getLastModificationTime()` Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` When the forecast creation task was created.
`void`	`setDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
`void`	`setForecastArn(String forecastArn)` The ARN of the forecast.
`void`	`setForecastName(String forecastName)` The name of the forecast.
`void`	`setLastModificationTime(Date lastModificationTime)` Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
`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.
`ForecastSummary`	`withCreationTime(Date creationTime)` When the forecast creation task was created.
`ForecastSummary`	`withDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
`ForecastSummary`	`withForecastArn(String forecastArn)` The ARN of the forecast.
`ForecastSummary`	`withForecastName(String forecastName)` The name of the forecast.
`ForecastSummary`	`withLastModificationTime(Date lastModificationTime)` Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
`ForecastSummary`	`withMessage(String message)` If an error occurred, an informational message about the error.
`ForecastSummary`	`withPredictorArn(String predictorArn)` The ARN of the predictor used to generate the forecast.
`ForecastSummary`	`withStatus(String status)` The status of the forecast.

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

- Constructor Detail
  - ForecastSummary
```
public ForecastSummary()
```
- Method Detail
  - setForecastArn
```
public void setForecastArn(String forecastArn)
```
    The ARN of the forecast.
    
    Parameters:
    
    forecastArn - The ARN of the forecast.
  - getForecastArn
```
public String getForecastArn()
```
    The ARN of the forecast.
    
    Returns:
    
    The ARN of the forecast.
  - withForecastArn
```
public ForecastSummary withForecastArn(String forecastArn)
```
    The ARN of the forecast.
    
    Parameters:
    
    forecastArn - The ARN of the forecast.
    
    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 ForecastSummary 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.
  - 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 ForecastSummary 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 Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
    
    Parameters:
    
    datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
  - getDatasetGroupArn
```
public String getDatasetGroupArn()
```
    The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
  - withDatasetGroupArn
```
public ForecastSummary withDatasetGroupArn(String datasetGroupArn)
```
    The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
    
    Parameters:
    
    datasetGroupArn - The Amazon Resource Name (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.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
  - getStatus
```
public String getStatus()
```
    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.
    Returns:
    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.
  - withStatus
```
public ForecastSummary withStatus(String 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.
    Parameters:
    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.
    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 ForecastSummary 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 ForecastSummary 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)
```
    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).
    
    Parameters:
    
    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).
  - getLastModificationTime
```
public Date getLastModificationTime()
```
    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).
    
    Returns:
    
    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).
  - withLastModificationTime
```
public ForecastSummary withLastModificationTime(Date 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).
    
    Parameters:
    
    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).
    
    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 ForecastSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ForecastSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForecastSummary

Method Detail

setForecastArn

getForecastArn

withForecastArn

setForecastName

getForecastName

withForecastName

setPredictorArn

getPredictorArn

withPredictorArn

setDatasetGroupArn

getDatasetGroupArn

withDatasetGroupArn

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone

marshall