WhatIfForecastExportSummary (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WhatIfForecastExportSummary()

Constructors
Constructor and Description
`WhatIfForecastExportSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WhatIfForecastExportSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the what-if forecast export was created.
`DataDestination`	`getDestination()` The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
`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 export.
`List<String>`	`getWhatIfForecastArns()` An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
`String`	`getWhatIfForecastExportArn()` The Amazon Resource Name (ARN) of the what-if forecast export.
`String`	`getWhatIfForecastExportName()` The what-if forecast export name.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` When the what-if forecast export was created.
`void`	`setDestination(DataDestination destination)` The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
`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 export.
`void`	`setWhatIfForecastArns(Collection<String> whatIfForecastArns)` An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
`void`	`setWhatIfForecastExportArn(String whatIfForecastExportArn)` The Amazon Resource Name (ARN) of the what-if forecast export.
`void`	`setWhatIfForecastExportName(String whatIfForecastExportName)` The what-if forecast export name.
`String`	`toString()` Returns a string representation of this object.
`WhatIfForecastExportSummary`	`withCreationTime(Date creationTime)` When the what-if forecast export was created.
`WhatIfForecastExportSummary`	`withDestination(DataDestination destination)` The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
`WhatIfForecastExportSummary`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`WhatIfForecastExportSummary`	`withMessage(String message)` If an error occurred, an informational message about the error.
`WhatIfForecastExportSummary`	`withStatus(String status)` The status of the what-if forecast export.
`WhatIfForecastExportSummary`	`withWhatIfForecastArns(Collection<String> whatIfForecastArns)` An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
`WhatIfForecastExportSummary`	`withWhatIfForecastArns(String... whatIfForecastArns)` An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
`WhatIfForecastExportSummary`	`withWhatIfForecastExportArn(String whatIfForecastExportArn)` The Amazon Resource Name (ARN) of the what-if forecast export.
`WhatIfForecastExportSummary`	`withWhatIfForecastExportName(String whatIfForecastExportName)` The what-if forecast export name.

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

- Constructor Detail
  - WhatIfForecastExportSummary
```
public WhatIfForecastExportSummary()
```
- Method Detail
  - setWhatIfForecastExportArn
```
public void setWhatIfForecastExportArn(String whatIfForecastExportArn)
```
    The Amazon Resource Name (ARN) of the what-if forecast export.
    
    Parameters:
    
    whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export.
  - getWhatIfForecastExportArn
```
public String getWhatIfForecastExportArn()
```
    The Amazon Resource Name (ARN) of the what-if forecast export.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if forecast export.
  - withWhatIfForecastExportArn
```
public WhatIfForecastExportSummary withWhatIfForecastExportArn(String whatIfForecastExportArn)
```
    The Amazon Resource Name (ARN) of the what-if forecast export.
    
    Parameters:
    
    whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWhatIfForecastArns
```
public List<String> getWhatIfForecastArns()
```
    An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
    
    Returns:
    
    An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
  - setWhatIfForecastArns
```
public void setWhatIfForecastArns(Collection<String> whatIfForecastArns)
```
    An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
    
    Parameters:
    
    whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
  - withWhatIfForecastArns
```
public WhatIfForecastExportSummary withWhatIfForecastArns(String... whatIfForecastArns)
```
    An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
    
    NOTE: This method appends the values to the existing list (if any). Use setWhatIfForecastArns(java.util.Collection) or withWhatIfForecastArns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWhatIfForecastArns
```
public WhatIfForecastExportSummary withWhatIfForecastArns(Collection<String> whatIfForecastArns)
```
    An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
    
    Parameters:
    
    whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWhatIfForecastExportName
```
public void setWhatIfForecastExportName(String whatIfForecastExportName)
```
    The what-if forecast export name.
    
    Parameters:
    
    whatIfForecastExportName - The what-if forecast export name.
  - getWhatIfForecastExportName
```
public String getWhatIfForecastExportName()
```
    The what-if forecast export name.
    
    Returns:
    
    The what-if forecast export name.
  - withWhatIfForecastExportName
```
public WhatIfForecastExportSummary withWhatIfForecastExportName(String whatIfForecastExportName)
```
    The what-if forecast export name.
    
    Parameters:
    
    whatIfForecastExportName - The what-if forecast export name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestination
```
public void setDestination(DataDestination destination)
```
    The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
    
    Parameters:
    
    destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
  - getDestination
```
public DataDestination getDestination()
```
    The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
    
    Returns:
    
    The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
  - withDestination
```
public WhatIfForecastExportSummary withDestination(DataDestination destination)
```
    The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
    
    Parameters:
    
    destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
    
    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 export. 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 export. 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 export. 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 export. 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 WhatIfForecastExportSummary withStatus(String status)
```
    The status of the what-if forecast export. 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 export. 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 WhatIfForecastExportSummary 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 export was created.
    
    Parameters:
    
    creationTime - When the what-if forecast export was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the what-if forecast export was created.
    
    Returns:
    
    When the what-if forecast export was created.
  - withCreationTime
```
public WhatIfForecastExportSummary withCreationTime(Date creationTime)
```
    When the what-if forecast export was created.
    
    Parameters:
    
    creationTime - When the what-if forecast export 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 WhatIfForecastExportSummary 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 WhatIfForecastExportSummary 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.580

Class WhatIfForecastExportSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WhatIfForecastExportSummary

Method Detail

setWhatIfForecastExportArn

getWhatIfForecastExportArn

withWhatIfForecastExportArn

getWhatIfForecastArns

setWhatIfForecastArns

withWhatIfForecastArns

withWhatIfForecastArns

setWhatIfForecastExportName

getWhatIfForecastExportName

withWhatIfForecastExportName

setDestination

getDestination

withDestination

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone

marshall