DescribeWhatIfAnalysisResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeWhatIfAnalysisResult()

Constructors
Constructor and Description
`DescribeWhatIfAnalysisResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeWhatIfAnalysisResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` When the what-if analysis was created.
`Long`	`getEstimatedTimeRemainingInMinutes()` The approximate time remaining to complete the what-if analysis, in minutes.
`String`	`getForecastArn()` The Amazon Resource Name (ARN) of the what-if forecast.
`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 analysis.
`TimeSeriesSelector`	`getTimeSeriesSelector()`
`String`	`getWhatIfAnalysisArn()` The Amazon Resource Name (ARN) of the what-if analysis.
`String`	`getWhatIfAnalysisName()` The name of the what-if analysis.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` When the what-if analysis was created.
`void`	`setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The approximate time remaining to complete the what-if analysis, in minutes.
`void`	`setForecastArn(String forecastArn)` The Amazon Resource Name (ARN) of the what-if forecast.
`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 analysis.
`void`	`setTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)`
`void`	`setWhatIfAnalysisArn(String whatIfAnalysisArn)` The Amazon Resource Name (ARN) of the what-if analysis.
`void`	`setWhatIfAnalysisName(String whatIfAnalysisName)` The name of the what-if analysis.
`String`	`toString()` Returns a string representation of this object.
`DescribeWhatIfAnalysisResult`	`withCreationTime(Date creationTime)` When the what-if analysis was created.
`DescribeWhatIfAnalysisResult`	`withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)` The approximate time remaining to complete the what-if analysis, in minutes.
`DescribeWhatIfAnalysisResult`	`withForecastArn(String forecastArn)` The Amazon Resource Name (ARN) of the what-if forecast.
`DescribeWhatIfAnalysisResult`	`withLastModificationTime(Date lastModificationTime)` The last time the resource was modified.
`DescribeWhatIfAnalysisResult`	`withMessage(String message)` If an error occurred, an informational message about the error.
`DescribeWhatIfAnalysisResult`	`withStatus(String status)` The status of the what-if analysis.
`DescribeWhatIfAnalysisResult`	`withTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)`
`DescribeWhatIfAnalysisResult`	`withWhatIfAnalysisArn(String whatIfAnalysisArn)` The Amazon Resource Name (ARN) of the what-if analysis.
`DescribeWhatIfAnalysisResult`	`withWhatIfAnalysisName(String whatIfAnalysisName)` The name of the what-if analysis.

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
  - DescribeWhatIfAnalysisResult
```
public DescribeWhatIfAnalysisResult()
```
- Method Detail
  - setWhatIfAnalysisName
```
public void setWhatIfAnalysisName(String whatIfAnalysisName)
```
    The name of the what-if analysis.
    
    Parameters:
    
    whatIfAnalysisName - The name of the what-if analysis.
  - getWhatIfAnalysisName
```
public String getWhatIfAnalysisName()
```
    The name of the what-if analysis.
    
    Returns:
    
    The name of the what-if analysis.
  - withWhatIfAnalysisName
```
public DescribeWhatIfAnalysisResult withWhatIfAnalysisName(String whatIfAnalysisName)
```
    The name of the what-if analysis.
    
    Parameters:
    
    whatIfAnalysisName - The name of the what-if analysis.
    
    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.
    
    Parameters:
    
    whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.
  - getWhatIfAnalysisArn
```
public String getWhatIfAnalysisArn()
```
    The Amazon Resource Name (ARN) of the what-if analysis.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if analysis.
  - withWhatIfAnalysisArn
```
public DescribeWhatIfAnalysisResult withWhatIfAnalysisArn(String whatIfAnalysisArn)
```
    The Amazon Resource Name (ARN) of the what-if analysis.
    
    Parameters:
    
    whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setForecastArn
```
public void setForecastArn(String forecastArn)
```
    The Amazon Resource Name (ARN) of the what-if forecast.
    
    Parameters:
    
    forecastArn - The Amazon Resource Name (ARN) of the what-if forecast.
  - getForecastArn
```
public String getForecastArn()
```
    The Amazon Resource Name (ARN) of the what-if forecast.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if forecast.
  - withForecastArn
```
public DescribeWhatIfAnalysisResult withForecastArn(String forecastArn)
```
    The Amazon Resource Name (ARN) of the what-if forecast.
    
    Parameters:
    
    forecastArn - 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.
  - setEstimatedTimeRemainingInMinutes
```
public void setEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The approximate time remaining to complete the what-if analysis, in minutes.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if analysis, in minutes.
  - getEstimatedTimeRemainingInMinutes
```
public Long getEstimatedTimeRemainingInMinutes()
```
    The approximate time remaining to complete the what-if analysis, in minutes.
    
    Returns:
    
    The approximate time remaining to complete the what-if analysis, in minutes.
  - withEstimatedTimeRemainingInMinutes
```
public DescribeWhatIfAnalysisResult withEstimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)
```
    The approximate time remaining to complete the what-if analysis, in minutes.
    
    Parameters:
    
    estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if analysis, 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 analysis. 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 analysis. 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 analysis. 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 analysis. 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 DescribeWhatIfAnalysisResult withStatus(String status)
```
    The status of the what-if analysis. 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 analysis. 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 DescribeWhatIfAnalysisResult 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 analysis was created.
    
    Parameters:
    
    creationTime - When the what-if analysis was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the what-if analysis was created.
    
    Returns:
    
    When the what-if analysis was created.
  - withCreationTime
```
public DescribeWhatIfAnalysisResult withCreationTime(Date creationTime)
```
    When the what-if analysis was created.
    
    Parameters:
    
    creationTime - When the what-if analysis 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 DescribeWhatIfAnalysisResult 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.
  - setTimeSeriesSelector
```
public void setTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)
```
    Parameters:
    
    timeSeriesSelector -
  - getTimeSeriesSelector
```
public TimeSeriesSelector getTimeSeriesSelector()
```
    Returns:
  - withTimeSeriesSelector
```
public DescribeWhatIfAnalysisResult withTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)
```
    Parameters:
    
    timeSeriesSelector -
    
    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 DescribeWhatIfAnalysisResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeWhatIfAnalysisResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeWhatIfAnalysisResult

Method Detail

setWhatIfAnalysisName

getWhatIfAnalysisName

withWhatIfAnalysisName

setWhatIfAnalysisArn

getWhatIfAnalysisArn

withWhatIfAnalysisArn

setForecastArn

getForecastArn

withForecastArn

setEstimatedTimeRemainingInMinutes

getEstimatedTimeRemainingInMinutes

withEstimatedTimeRemainingInMinutes

setStatus

getStatus

withStatus

setMessage

getMessage

withMessage

setCreationTime

getCreationTime

withCreationTime

setLastModificationTime

getLastModificationTime

withLastModificationTime

setTimeSeriesSelector

getTimeSeriesSelector

withTimeSeriesSelector

toString

equals

hashCode

clone