java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.forecast.model.ForecastResponse
    - - software.amazon.awssdk.services.forecast.model.DescribeWhatIfForecastExportResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeWhatIfForecastExportResponse.Builder,DescribeWhatIfForecastExportResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeWhatIfForecastExportResponse
extends ForecastResponse
implements ToCopyableBuilder<DescribeWhatIfForecastExportResponse.Builder,DescribeWhatIfForecastExportResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeWhatIfForecastExportResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeWhatIfForecastExportResponse.Builder`	`builder()`
`Instant`	`creationTime()`	When the what-if forecast export was created.
`DataDestination`	`destination()`	Returns the value of the Destination property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`estimatedTimeRemainingInMinutes()`	The approximate time remaining to complete the what-if forecast export, in minutes.
`String`	`format()`	The format of the exported data, CSV or PARQUET.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasWhatIfForecastArns()`	For responses, this returns true if the service returned a value for the WhatIfForecastArns property.
`Instant`	`lastModificationTime()`	The last time the resource was modified.
`String`	`message()`	If an error occurred, an informational message about the error.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeWhatIfForecastExportResponse.Builder>`	`serializableBuilderClass()`
`String`	`status()`	The status of the what-if forecast.
`DescribeWhatIfForecastExportResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`whatIfForecastArns()`	An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
`String`	`whatIfForecastExportArn()`	The Amazon Resource Name (ARN) of the what-if forecast export.
`String`	`whatIfForecastExportName()`	The name of the what-if forecast export.

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - whatIfForecastExportArn
```
public final String whatIfForecastExportArn()
```
    The Amazon Resource Name (ARN) of the what-if forecast export.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if forecast export.
  - whatIfForecastExportName
```
public final String whatIfForecastExportName()
```
    The name of the what-if forecast export.
    
    Returns:
    
    The name of the what-if forecast export.
  - hasWhatIfForecastArns
```
public final boolean hasWhatIfForecastArns()
```
    For responses, this returns true if the service returned a value for the WhatIfForecastArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - whatIfForecastArns
```
public final List<String> whatIfForecastArns()
```
    An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWhatIfForecastArns() method.
    
    Returns:
    
    An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
  - destination
```
public final DataDestination destination()
```
    Returns the value of the Destination property for this object.
    
    Returns:
    
    The value of the Destination property for this object.
  - message
```
public final String message()
```
    If an error occurred, an informational message about the error.
    
    Returns:
    
    If an error occurred, an informational message about the error.
  - status
```
public final 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 export must be ACTIVE before you can access the forecast export.
    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 export must be ACTIVE before you can access the forecast export.
  - creationTime
```
public final Instant creationTime()
```
    When the what-if forecast export was created.
    
    Returns:
    
    When the what-if forecast export was created.
  - estimatedTimeRemainingInMinutes
```
public final Long estimatedTimeRemainingInMinutes()
```
    The approximate time remaining to complete the what-if forecast export, in minutes.
    
    Returns:
    
    The approximate time remaining to complete the what-if forecast export, in minutes.
  - lastModificationTime
```
public final Instant 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:
    
    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.
  - format
```
public final String format()
```
    The format of the exported data, CSV or PARQUET.
    
    Returns:
    
    The format of the exported data, CSV or PARQUET.
  - toBuilder
```
public DescribeWhatIfForecastExportResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeWhatIfForecastExportResponse.Builder,DescribeWhatIfForecastExportResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeWhatIfForecastExportResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeWhatIfForecastExportResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeWhatIfForecastExportResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

whatIfForecastExportArn

whatIfForecastExportName

hasWhatIfForecastArns

whatIfForecastArns

destination

message

status

creationTime

estimatedTimeRemainingInMinutes

lastModificationTime

format

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField