Class ListWhatIfForecastExportsRequest
- 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.ListWhatIfForecastExportsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListWhatIfForecastExportsRequest.Builder,ListWhatIfForecastExportsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListWhatIfForecastExportsRequest extends ForecastRequest implements ToCopyableBuilder<ListWhatIfForecastExportsRequest.Builder,ListWhatIfForecastExportsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListWhatIfForecastExportsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListWhatIfForecastExportsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Filter>filters()An array of filters.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()IntegermaxResults()The number of items to return in the response.StringnextToken()If the result of the previous request was truncated, the response includes aNextToken.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListWhatIfForecastExportsRequest.Builder>serializableBuilderClass()ListWhatIfForecastExportsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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.
-
maxResults
public final Integer maxResults()
The number of items to return in the response.
- Returns:
- The number of items to return in the response.
-
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 theisEmpty()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 List<Filter> filters()
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
ISorIS_NOT, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. To include the forecast export jobs that match the statement, specifyIS. To exclude matching forecast export jobs, specifyIS_NOT. -
Key- The name of the parameter to filter on. Valid values areWhatIfForecastExportArnandStatus. -
Value- The value to match.
For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]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:
- An array of filters. For each filter, you provide a condition and a match statement. The condition is
either
ISorIS_NOT, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. To include the forecast export jobs that match the statement, specifyIS. To exclude matching forecast export jobs, specifyIS_NOT. -
Key- The name of the parameter to filter on. Valid values areWhatIfForecastExportArnandStatus. -
Value- The value to match.
For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ] -
-
-
toBuilder
public ListWhatIfForecastExportsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListWhatIfForecastExportsRequest.Builder,ListWhatIfForecastExportsRequest>- Specified by:
toBuilderin classForecastRequest
-
builder
public static ListWhatIfForecastExportsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListWhatIfForecastExportsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-