Class SearchFixturesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.elementalinference.model.ElementalInferenceRequest
software.amazon.awssdk.services.elementalinference.model.SearchFixturesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchFixturesRequest.Builder,SearchFixturesRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchFixturesRequest extends ElementalInferenceRequest implements ToCopyableBuilder<SearchFixturesRequest.Builder,SearchFixturesRequest>

  • Method Details

    • sport

      public final DataSourceSport sport()

      The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).

      If the service returns an enum value that is not available in the current SDK version, sport will return DataSourceSport.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sportAsString().

      Returns:
      The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).
      See Also:

    • sportAsString

      public final String sportAsString()

      The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).

      If the service returns an enum value that is not available in the current SDK version, sport will return DataSourceSport.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sportAsString().

      Returns:
      The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).
      See Also:

    • startDate

      public final String startDate()

      The first day of the search window, in UTC. The search includes fixtures that are scheduled on this day.

      Specify the date in ISO 8601 format, as YYYY-MM-DD. For example, 2026-03-14.

      Returns:
      The first day of the search window, in UTC. The search includes fixtures that are scheduled on this day.

      Specify the date in ISO 8601 format, as YYYY-MM-DD. For example, 2026-03-14.

    • endDate

      public final String endDate()

      The last day of the search window, in UTC. The search includes fixtures that are scheduled on this day. Specify the date in ISO 8601 format, as YYYY-MM-DD.

      If you omit this parameter, Elemental Inference searches only the day that you specified in startDate. The window from startDate through endDate must not exceed seven days.

      Returns:
      The last day of the search window, in UTC. The search includes fixtures that are scheduled on this day. Specify the date in ISO 8601 format, as YYYY-MM-DD.

      If you omit this parameter, Elemental Inference searches only the day that you specified in startDate. The window from startDate through endDate must not exceed seven days.

    • 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<SearchFilter> filters()

      An array of filters that narrow the results. Each filter applies to one dimension of a fixture, such as the competitor. You can specify up to 10 filters.

      A fixture must satisfy every filter in the array in order to appear in the results. Within one filter, a fixture must match at least one of the values.

      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 that narrow the results. Each filter applies to one dimension of a fixture, such as the competitor. You can specify up to 10 filters.

      A fixture must satisfy every filter in the array in order to appear in the results. Within one filter, a fixture must match at least one of the values.

    • maxResults

      public final Integer maxResults()

      The maximum number of fixtures to return for each API request.

      The service might return fewer fixtures than the maxResults value. When more fixtures match the search, the response also includes a nextToken value that you can use to fetch the next batch of results.

      Returns:
      The maximum number of fixtures to return for each API request.

      The service might return fewer fixtures than the maxResults value. When more fixtures match the search, the response also includes a nextToken value that you can use to fetch the next batch of results.

    • nextToken

      public final String nextToken()

      The token that identifies the batch of results that you want to see.

      For example, you submit a SearchFixtures request with maxResults set at 5. The service returns the first batch of results (up to 5) and a nextToken value. To see the next batch of results, you submit the SearchFixtures request a second time, with the same search criteria, and specify the nextToken value.

      Returns:
      The token that identifies the batch of results that you want to see.

      For example, you submit a SearchFixtures request with maxResults set at 5. The service returns the first batch of results (up to 5) and a nextToken value. To see the next batch of results, you submit the SearchFixtures request a second time, with the same search criteria, and specify the nextToken value.

    • toBuilder

      public SearchFixturesRequest.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<SearchFixturesRequest.Builder,SearchFixturesRequest>
      Specified by:
      toBuilder in class ElementalInferenceRequest
      Returns:
      a builder for type T

    • builder

      public static SearchFixturesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchFixturesRequest.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.