Class ListForecastsRequest

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.ListForecastsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListForecastsRequest.Builder,ListForecastsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListForecastsRequest extends ForecastRequest implements ToCopyableBuilder<ListForecastsRequest.Builder,ListForecastsRequest>

  • Method Details

    • 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 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 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.

      Returns:
      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" } ]

    • toBuilder

      public ListForecastsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListForecastsRequest.Builder,ListForecastsRequest>
      Specified by:
      toBuilder in class ForecastRequest
      Returns:
      a builder for type T

    • builder

      public static ListForecastsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListForecastsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.