WhatIfForecastSummary (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WhatIfForecastSummary()

Constructors
Constructor and Description
`WhatIfForecastSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WhatIfForecastSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the what-if forecast was created.
`Date`	`getLastModificationTime()` The last time the resource was modified.
`String`	`getMessage()` If an error occurred, an informational message about the error.
`String`	`getStatus()` The status of the what-if forecast.
`String`	`getWhatIfAnalysisArn()` The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
`String`	`getWhatIfForecastArn()` The Amazon Resource Name (ARN) of the what-if forecast.
`String`	`getWhatIfForecastName()` The name of the what-if forecast.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` When the what-if forecast was created.
`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`	`setStatus(String status)` The status of the what-if forecast.
`void`	`setWhatIfAnalysisArn(String whatIfAnalysisArn)` The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
`void`	`setWhatIfForecastArn(String whatIfForecastArn)` The Amazon Resource Name (ARN) of the what-if forecast.
`void`	`setWhatIfForecastName(String whatIfForecastName)` The name of the what-if forecast.
`String`	`toString()` Returns a string representation of this object.
`WhatIfForecastSummary`	`withCreationTime(Date creationTime)` When the what-if forecast was created.
`WhatIfForecastSummary`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`WhatIfForecastSummary`	`withMessage(String message)` If an error occurred, an informational message about the error.
`WhatIfForecastSummary`	`withStatus(String status)` The status of the what-if forecast.
`WhatIfForecastSummary`	`withWhatIfAnalysisArn(String whatIfAnalysisArn)` The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
`WhatIfForecastSummary`	`withWhatIfForecastArn(String whatIfForecastArn)` The Amazon Resource Name (ARN) of the what-if forecast.
`WhatIfForecastSummary`	`withWhatIfForecastName(String whatIfForecastName)` The name of the what-if forecast.

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

- Constructor Detail
  - WhatIfForecastSummary
```
public WhatIfForecastSummary()
```
- Method Detail
  - setWhatIfForecastArn
```
public void setWhatIfForecastArn(String whatIfForecastArn)
```
    The Amazon Resource Name (ARN) of the what-if forecast.
    
    Parameters:
    
    whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast.
  - getWhatIfForecastArn
```
public String getWhatIfForecastArn()
```
    The Amazon Resource Name (ARN) of the what-if forecast.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if forecast.
  - withWhatIfForecastArn
```
public WhatIfForecastSummary withWhatIfForecastArn(String whatIfForecastArn)
```
    The Amazon Resource Name (ARN) of the what-if forecast.
    
    Parameters:
    
    whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWhatIfForecastName
```
public void setWhatIfForecastName(String whatIfForecastName)
```
    The name of the what-if forecast.
    
    Parameters:
    
    whatIfForecastName - The name of the what-if forecast.
  - getWhatIfForecastName
```
public String getWhatIfForecastName()
```
    The name of the what-if forecast.
    
    Returns:
    
    The name of the what-if forecast.
  - withWhatIfForecastName
```
public WhatIfForecastSummary withWhatIfForecastName(String whatIfForecastName)
```
    The name of the what-if forecast.
    
    Parameters:
    
    whatIfForecastName - The name of the what-if forecast.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWhatIfAnalysisArn
```
public void setWhatIfAnalysisArn(String whatIfAnalysisArn)
```
    The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
    
    Parameters:
    
    whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
  - getWhatIfAnalysisArn
```
public String getWhatIfAnalysisArn()
```
    The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
  - withWhatIfAnalysisArn
```
public WhatIfForecastSummary withWhatIfAnalysisArn(String whatIfAnalysisArn)
```
    The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
    
    Parameters:
    
    whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
    
    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 what-if 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 what-if analysis must be ACTIVE before you can access the analysis.
    Parameters:
    status - The status of the what-if 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 what-if analysis must be ACTIVE before you can access the analysis.
  - getStatus
```
public String getStatus()
```
    The status of the what-if 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 what-if analysis must be ACTIVE before you can access the analysis.
    Returns:
    The status of the what-if 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 what-if analysis must be ACTIVE before you can access the analysis.
  - withStatus
```
public WhatIfForecastSummary withStatus(String status)
```
    The status of the what-if 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 what-if analysis must be ACTIVE before you can access the analysis.
    Parameters:
    status - The status of the what-if 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 what-if analysis must be ACTIVE before you can access the analysis.
    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 WhatIfForecastSummary 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 what-if forecast was created.
    
    Parameters:
    
    creationTime - When the what-if forecast was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the what-if forecast was created.
    
    Returns:
    
    When the what-if forecast was created.
  - withCreationTime
```
public WhatIfForecastSummary withCreationTime(Date creationTime)
```
    When the what-if forecast was created.
    
    Parameters:
    
    creationTime - When the what-if forecast 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 WhatIfForecastSummary 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 WhatIfForecastSummary 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class WhatIfForecastSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WhatIfForecastSummary

Method Detail

setWhatIfForecastArn

getWhatIfForecastArn

withWhatIfForecastArn

setWhatIfForecastName

getWhatIfForecastName

withWhatIfForecastName

setWhatIfAnalysisArn

getWhatIfAnalysisArn

withWhatIfAnalysisArn

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone

marshall