@Generated(value="software.amazon.awssdk:codegen") public final class ListForecastsRequest extends ForecastRequest implements ToCopyableBuilder<ListForecastsRequest.Builder,ListForecastsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListForecastsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListForecastsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<Filter> |
filters()
An array of filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.
|
int |
hashCode() |
Integer |
maxResults()
The number of items to return in the response.
|
String |
nextToken()
If the result of the previous request was truncated, the response includes a
NextToken. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListForecastsRequest.Builder> |
serializableBuilderClass() |
ListForecastsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic 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.
NextToken. To
retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.public final Integer maxResults()
The number of items to return in the response.
public final boolean hasFilters()
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.public final List<Filter> filters()
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS or IS_NOT, which specifies whether to include or exclude the forecasts 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 are IS and IS_NOT. To
include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify
IS_NOT.
Key - The name of the parameter to filter on. Valid values are DatasetGroupArn,
PredictorArn, and Status.
Value - The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
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.
IS or IS_NOT, which specifies whether to include or exclude the
forecasts 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 are IS and IS_NOT
. To include the forecasts that match the statement, specify IS. To exclude matching
forecasts, specify IS_NOT.
Key - The name of the parameter to filter on. Valid values are DatasetGroupArn,
PredictorArn, and Status.
Value - The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
public ListForecastsRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListForecastsRequest.Builder,ListForecastsRequest>toBuilder in class ForecastRequestpublic static ListForecastsRequest.Builder builder()
public static Class<? extends ListForecastsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.