Interface SearchFixturesRequest.Builder

  • Method Details

    • sport

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

      Parameters:
      sport - The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sport

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

      Parameters:
      sport - The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startDate

      SearchFixturesRequest.Builder startDate(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      This is a convenience method that creates an instance of the SearchFilter.Builder avoiding the need to create one manually via SearchFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<SearchFilter>).

      Parameters:
      filters - a consumer that will call methods on SearchFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • maxResults

      SearchFixturesRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • nextToken

      SearchFixturesRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      SearchFixturesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.