java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.forecast.model.ForecastRequest
    - - software.amazon.awssdk.services.forecast.model.CreateWhatIfForecastExportRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateWhatIfForecastExportRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateWhatIfForecastExportRequest.Builder`	`builder()`
`DataDestination`	`destination()`	The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`format()`	The format of the exported data, CSV or PARQUET.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasWhatIfForecastArns()`	For responses, this returns true if the service returned a value for the WhatIfForecastArns property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateWhatIfForecastExportRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A list of tags to apply to the what if forecast.
`CreateWhatIfForecastExportRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`whatIfForecastArns()`	The list of what-if forecast Amazon Resource Names (ARNs) to export.
`String`	`whatIfForecastExportName()`	The name of the what-if forecast to export.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - whatIfForecastExportName
```
public final String whatIfForecastExportName()
```
    The name of the what-if forecast to export.
    
    Returns:
    
    The name of the what-if forecast to 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()
```
    The list of what-if forecast Amazon Resource Names (ARNs) to export.
    
    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:
    
    The list of what-if forecast Amazon Resource Names (ARNs) to export.
  - destination
```
public final DataDestination destination()
```
    The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
    
    If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
    
    Returns:
    
    The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
    
    If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    A list of tags to apply to the what if forecast.
    
    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 hasTags() method.
    
    Returns:
    
    A list of tags to apply to the what if forecast.
  - 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 CreateWhatIfForecastExportRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateWhatIfForecastExportRequest.Builder,CreateWhatIfForecastExportRequest>
    
    Specified by:
    
    toBuilder in class ForecastRequest
  - builder
```
public static CreateWhatIfForecastExportRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateWhatIfForecastExportRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateWhatIfForecastExportRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

whatIfForecastExportName

hasWhatIfForecastArns

whatIfForecastArns

destination

hasTags

tags

format

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields