ForecastExportJobSummary (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ForecastExportJobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ForecastExportJobSummary()

Constructors
Constructor and Description
`ForecastExportJobSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ForecastExportJobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the forecast export job was created.
`DataDestination`	`getDestination()` The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
`String`	`getForecastExportJobArn()` The Amazon Resource Name (ARN) of the forecast export job.
`String`	`getForecastExportJobName()` The name of the forecast export job.
`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 forecast export job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` When the forecast export job was created.
`void`	`setDestination(DataDestination destination)` The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
`void`	`setForecastExportJobArn(String forecastExportJobArn)` The Amazon Resource Name (ARN) of the forecast export job.
`void`	`setForecastExportJobName(String forecastExportJobName)` The name of the forecast export job.
`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 forecast export job.
`String`	`toString()` Returns a string representation of this object.
`ForecastExportJobSummary`	`withCreationTime(Date creationTime)` When the forecast export job was created.
`ForecastExportJobSummary`	`withDestination(DataDestination destination)` The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
`ForecastExportJobSummary`	`withForecastExportJobArn(String forecastExportJobArn)` The Amazon Resource Name (ARN) of the forecast export job.
`ForecastExportJobSummary`	`withForecastExportJobName(String forecastExportJobName)` The name of the forecast export job.
`ForecastExportJobSummary`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`ForecastExportJobSummary`	`withMessage(String message)` If an error occurred, an informational message about the error.
`ForecastExportJobSummary`	`withStatus(String status)` The status of the forecast export job.

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

- Constructor Detail
  - ForecastExportJobSummary
```
public ForecastExportJobSummary()
```
- Method Detail
  - setForecastExportJobArn
```
public void setForecastExportJobArn(String forecastExportJobArn)
```
    The Amazon Resource Name (ARN) of the forecast export job.
    
    Parameters:
    
    forecastExportJobArn - The Amazon Resource Name (ARN) of the forecast export job.
  - getForecastExportJobArn
```
public String getForecastExportJobArn()
```
    The Amazon Resource Name (ARN) of the forecast export job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the forecast export job.
  - withForecastExportJobArn
```
public ForecastExportJobSummary withForecastExportJobArn(String forecastExportJobArn)
```
    The Amazon Resource Name (ARN) of the forecast export job.
    
    Parameters:
    
    forecastExportJobArn - The Amazon Resource Name (ARN) of the forecast export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setForecastExportJobName
```
public void setForecastExportJobName(String forecastExportJobName)
```
    The name of the forecast export job.
    
    Parameters:
    
    forecastExportJobName - The name of the forecast export job.
  - getForecastExportJobName
```
public String getForecastExportJobName()
```
    The name of the forecast export job.
    
    Returns:
    
    The name of the forecast export job.
  - withForecastExportJobName
```
public ForecastExportJobSummary withForecastExportJobName(String forecastExportJobName)
```
    The name of the forecast export job.
    
    Parameters:
    
    forecastExportJobName - The name of the forecast export job.
    
    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 ForecastExportJobSummary 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 forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.
    Parameters:
    status - The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.
  - getStatus
```
public String getStatus()
```
    The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.
    Returns:
    The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.
  - withStatus
```
public ForecastExportJobSummary withStatus(String status)
```
    The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.
    Parameters:
    status - The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.
    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 ForecastExportJobSummary 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 export job was created.
    
    Parameters:
    
    creationTime - When the forecast export job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the forecast export job was created.
    
    Returns:
    
    When the forecast export job was created.
  - withCreationTime
```
public ForecastExportJobSummary withCreationTime(Date creationTime)
```
    When the forecast export job was created.
    
    Parameters:
    
    creationTime - When the forecast export job 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 ForecastExportJobSummary 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 ForecastExportJobSummary 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 ForecastExportJobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForecastExportJobSummary

Method Detail

setForecastExportJobArn

getForecastExportJobArn

withForecastExportJobArn

setForecastExportJobName

getForecastExportJobName

withForecastExportJobName

setDestination

getDestination

withDestination

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

toString

equals

hashCode

clone

marshall