Interface DescribeEventsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>, HealthRequest.Builder, SdkBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeEventsRequest
@Mutable @NotThreadSafe public static interface DescribeEventsRequest.Builder extends HealthRequest.Builder, SdkPojo, CopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

  • Method Details

    • filter

      DescribeEventsRequest.Builder filter(EventFilter filter)

      Values to narrow the results returned.

      Parameters:
      filter - Values to narrow the results returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default DescribeEventsRequest.Builder filter(Consumer<EventFilter.Builder> filter)

      Values to narrow the results returned.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(EventFilter).

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

    • nextToken

      DescribeEventsRequest.Builder nextToken(String nextToken)

      If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

      Parameters:
      nextToken - If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeEventsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return in one batch, between 10 and 100, inclusive.

      Parameters:
      maxResults - The maximum number of items to return in one batch, between 10 and 100, inclusive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locale

      DescribeEventsRequest.Builder locale(String locale)

      The locale (language) to return information in. English (en) is the default and the only supported value at this time.

      Parameters:
      locale - The locale (language) to return information in. English (en) is the default and the only supported value at this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

      DescribeEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.