DescribeWhatIfForecastResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeWhatIfForecastResult()

Constructors
Constructor and Description
`DescribeWhatIfForecastResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeWhatIfForecastResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the what-if forecast was created.
`Long`	`getEstimatedTimeRemainingInMinutes()` The approximate time remaining to complete the what-if forecast, in minutes.
`List<String>`	`getForecastTypes()` The quantiles at which probabilistic forecasts are generated.
`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.
`TimeSeriesReplacementsDataSource`	`getTimeSeriesReplacementsDataSource()` An array of `S3Config`, `Schema`, and `Format` elements that describe the replacement time series.
`List<TimeSeriesTransformation>`	`getTimeSeriesTransformations()` An array of `Action` and `TimeSeriesConditions` elements that describe what transformations were applied to which time series.
`String`	`getWhatIfAnalysisArn()` The Amazon Resource Name (ARN) of the what-if analysis that contains this 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`	`setCreationTime(Date creationTime)` When the what-if forecast was created.
`void`	`setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The approximate time remaining to complete the what-if forecast, in minutes.
`void`	`setForecastTypes(Collection<String> forecastTypes)` The quantiles at which probabilistic forecasts are 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`	`setStatus(String status)` The status of the what-if forecast.
`void`	`setTimeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)` An array of `S3Config`, `Schema`, and `Format` elements that describe the replacement time series.
`void`	`setTimeSeriesTransformations(Collection<TimeSeriesTransformation> timeSeriesTransformations)` An array of `Action` and `TimeSeriesConditions` elements that describe what transformations were applied to which time series.
`void`	`setWhatIfAnalysisArn(String whatIfAnalysisArn)` The Amazon Resource Name (ARN) of the what-if analysis that contains this 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.
`DescribeWhatIfForecastResult`	`withCreationTime(Date creationTime)` When the what-if forecast was created.
`DescribeWhatIfForecastResult`	`withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The approximate time remaining to complete the what-if forecast, in minutes.
`DescribeWhatIfForecastResult`	`withForecastTypes(Collection<String> forecastTypes)` The quantiles at which probabilistic forecasts are generated.
`DescribeWhatIfForecastResult`	`withForecastTypes(String... forecastTypes)` The quantiles at which probabilistic forecasts are generated.
`DescribeWhatIfForecastResult`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`DescribeWhatIfForecastResult`	`withMessage(String message)` If an error occurred, an informational message about the error.
`DescribeWhatIfForecastResult`	`withStatus(String status)` The status of the what-if forecast.
`DescribeWhatIfForecastResult`	`withTimeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)` An array of `S3Config`, `Schema`, and `Format` elements that describe the replacement time series.
`DescribeWhatIfForecastResult`	`withTimeSeriesTransformations(Collection<TimeSeriesTransformation> timeSeriesTransformations)` An array of `Action` and `TimeSeriesConditions` elements that describe what transformations were applied to which time series.
`DescribeWhatIfForecastResult`	`withTimeSeriesTransformations(TimeSeriesTransformation... timeSeriesTransformations)` An array of `Action` and `TimeSeriesConditions` elements that describe what transformations were applied to which time series.
`DescribeWhatIfForecastResult`	`withWhatIfAnalysisArn(String whatIfAnalysisArn)` The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
`DescribeWhatIfForecastResult`	`withWhatIfForecastArn(String whatIfForecastArn)` The Amazon Resource Name (ARN) of the what-if forecast.
`DescribeWhatIfForecastResult`	`withWhatIfForecastName(String whatIfForecastName)` The name of the what-if 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
  - DescribeWhatIfForecastResult
```
public DescribeWhatIfForecastResult()
```
- Method Detail
  - 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 DescribeWhatIfForecastResult 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.
  - 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 DescribeWhatIfForecastResult 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.
  - setWhatIfAnalysisArn
```
public void setWhatIfAnalysisArn(String whatIfAnalysisArn)
```
    The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
    
    Parameters:
    
    whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
  - getWhatIfAnalysisArn
```
public String getWhatIfAnalysisArn()
```
    The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
  - withWhatIfAnalysisArn
```
public DescribeWhatIfForecastResult withWhatIfAnalysisArn(String whatIfAnalysisArn)
```
    The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
    
    Parameters:
    
    whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEstimatedTimeRemainingInMinutes
```
public void setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The approximate time remaining to complete the what-if forecast, in minutes.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if forecast, in minutes.
  - getEstimatedTimeRemainingInMinutes
```
public Long getEstimatedTimeRemainingInMinutes()
```
    The approximate time remaining to complete the what-if forecast, in minutes.
    
    Returns:
    
    The approximate time remaining to complete the what-if forecast, in minutes.
  - withEstimatedTimeRemainingInMinutes
```
public DescribeWhatIfForecastResult withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The approximate time remaining to complete the what-if forecast, in minutes.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if forecast, in minutes.
    
    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 forecast must be ACTIVE before you can access the forecast.
    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 forecast must be ACTIVE before you can access the forecast.
  - 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 forecast must be ACTIVE before you can access the forecast.
    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 forecast must be ACTIVE before you can access the forecast.
  - withStatus
```
public DescribeWhatIfForecastResult 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 forecast must be ACTIVE before you can access the forecast.
    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 forecast must be ACTIVE before you can access 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 DescribeWhatIfForecastResult 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 DescribeWhatIfForecastResult 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 DescribeWhatIfForecastResult 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.
  - getTimeSeriesTransformations
```
public List<TimeSeriesTransformation> getTimeSeriesTransformations()
```
    An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
    
    Returns:
    
    An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
  - setTimeSeriesTransformations
```
public void setTimeSeriesTransformations(Collection<TimeSeriesTransformation> timeSeriesTransformations)
```
    An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
    
    Parameters:
    
    timeSeriesTransformations - An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
  - withTimeSeriesTransformations
```
public DescribeWhatIfForecastResult withTimeSeriesTransformations(TimeSeriesTransformation... timeSeriesTransformations)
```
    An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
    
    NOTE: This method appends the values to the existing list (if any). Use setTimeSeriesTransformations(java.util.Collection) or withTimeSeriesTransformations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    timeSeriesTransformations - An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTimeSeriesTransformations
```
public DescribeWhatIfForecastResult withTimeSeriesTransformations(Collection<TimeSeriesTransformation> timeSeriesTransformations)
```
    An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
    
    Parameters:
    
    timeSeriesTransformations - An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeSeriesReplacementsDataSource
```
public void setTimeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)
```
    An array of S3Config, Schema, and Format elements that describe the replacement time series.
    
    Parameters:
    
    timeSeriesReplacementsDataSource - An array of S3Config, Schema, and Format elements that describe the replacement time series.
  - getTimeSeriesReplacementsDataSource
```
public TimeSeriesReplacementsDataSource getTimeSeriesReplacementsDataSource()
```
    An array of S3Config, Schema, and Format elements that describe the replacement time series.
    
    Returns:
    
    An array of S3Config, Schema, and Format elements that describe the replacement time series.
  - withTimeSeriesReplacementsDataSource
```
public DescribeWhatIfForecastResult withTimeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)
```
    An array of S3Config, Schema, and Format elements that describe the replacement time series.
    
    Parameters:
    
    timeSeriesReplacementsDataSource - An array of S3Config, Schema, and Format elements that describe the replacement time series.
    
    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 are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    
    Returns:
    
    The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
  - setForecastTypes
```
public void setForecastTypes(Collection<String> forecastTypes)
```
    The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    
    Parameters:
    
    forecastTypes - The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
  - withForecastTypes
```
public DescribeWhatIfForecastResult withForecastTypes(String... forecastTypes)
```
    The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    
    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 are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withForecastTypes
```
public DescribeWhatIfForecastResult withForecastTypes(Collection<String> forecastTypes)
```
    The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    
    Parameters:
    
    forecastTypes - The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    
    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 DescribeWhatIfForecastResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.778

Class DescribeWhatIfForecastResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeWhatIfForecastResult

Method Detail

setWhatIfForecastName

getWhatIfForecastName

withWhatIfForecastName

setWhatIfForecastArn

getWhatIfForecastArn

withWhatIfForecastArn

setWhatIfAnalysisArn

getWhatIfAnalysisArn

withWhatIfAnalysisArn

setEstimatedTimeRemainingInMinutes

getEstimatedTimeRemainingInMinutes

withEstimatedTimeRemainingInMinutes

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

getTimeSeriesTransformations

setTimeSeriesTransformations

withTimeSeriesTransformations

withTimeSeriesTransformations

setTimeSeriesReplacementsDataSource

getTimeSeriesReplacementsDataSource

withTimeSeriesReplacementsDataSource

getForecastTypes

setForecastTypes

withForecastTypes

withForecastTypes

toString

equals

hashCode

clone