java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.forecastquery.model.ForecastqueryRequest
    - - software.amazon.awssdk.services.forecastquery.model.QueryWhatIfForecastRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface QueryWhatIfForecastRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static QueryWhatIfForecastRequest.Builder`	`builder()`
`String`	`endDate()`	The end date for the what-if forecast.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<String,String>`	`filters()`	The filtering criteria to apply when retrieving the forecast.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`String`	`nextToken()`	If the result of the previous request was truncated, the response includes a `NextToken`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends QueryWhatIfForecastRequest.Builder>`	`serializableBuilderClass()`
`String`	`startDate()`	The start date for the what-if forecast.
`QueryWhatIfForecastRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`whatIfForecastArn()`	The Amazon Resource Name (ARN) of the what-if forecast to query.

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
  - whatIfForecastArn
```
public final String whatIfForecastArn()
```
    The Amazon Resource Name (ARN) of the what-if forecast to query.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the what-if forecast to query.
  - startDate
```
public final String startDate()
```
    The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
    
    Returns:
    
    The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
  - endDate
```
public final String endDate()
```
    The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
    
    Returns:
    
    The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters 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.
  - filters
```
public final Map<String,String> filters()
```
    The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:
    
    {"item_id" : "client_21"}
    
    To get the full what-if forecast, use the CreateForecastExportJob operation.
    
    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 hasFilters() method.
    
    Returns:
    
    The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:
    
    {"item_id" : "client_21"}
    
    To get the full what-if forecast, use the CreateForecastExportJob operation.
  - nextToken
```
public final String nextToken()
```
    If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
    
    Returns:
    
    If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
  - toBuilder
```
public QueryWhatIfForecastRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<QueryWhatIfForecastRequest.Builder,QueryWhatIfForecastRequest>
    
    Specified by:
    
    toBuilder in class ForecastqueryRequest
  - builder
```
public static QueryWhatIfForecastRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends QueryWhatIfForecastRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class QueryWhatIfForecastRequest

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

whatIfForecastArn

startDate

endDate

hasFilters

filters

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField