software.amazon.awssdk.services.health.model

Interface DescribeEventAggregatesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeEventAggregatesRequest.Builder,DescribeEventAggregatesRequest>, HealthRequest.Builder, SdkBuilder<DescribeEventAggregatesRequest.Builder,DescribeEventAggregatesRequest>, SdkRequest.Builder

Enclosing class:

DescribeEventAggregatesRequest

public static interface DescribeEventAggregatesRequest.Builder
extends HealthRequest.Builder, CopyableBuilder<DescribeEventAggregatesRequest.Builder,DescribeEventAggregatesRequest>

Method Summary

Modifier and Type	Method and Description
DescribeEventAggregatesRequest.Builder	aggregateField(EventAggregateField aggregateField) The only currently supported value is eventTypeCategory.
DescribeEventAggregatesRequest.Builder	aggregateField(String aggregateField) The only currently supported value is eventTypeCategory.
default DescribeEventAggregatesRequest.Builder	filter(Consumer<EventFilter.Builder> filter) Values to narrow the results returned.
DescribeEventAggregatesRequest.Builder	filter(EventFilter filter) Values to narrow the results returned.
DescribeEventAggregatesRequest.Builder	maxResults(Integer maxResults) The maximum number of items to return in one batch, between 10 and 100, inclusive.
DescribeEventAggregatesRequest.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.
DescribeEventAggregatesRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeEventAggregatesRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.health.model.HealthRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

filter

DescribeEventAggregatesRequest.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 DescribeEventAggregatesRequest.Builder filter(Consumer<EventFilter.Builder> filter)

Values to narrow the results returned.

This is a convenience 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:

filter(EventFilter)

aggregateField

DescribeEventAggregatesRequest.Builder aggregateField(String aggregateField)

The only currently supported value is eventTypeCategory.

Parameters:

aggregateField - The only currently supported value is eventTypeCategory.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EventAggregateField, EventAggregateField

aggregateField

DescribeEventAggregatesRequest.Builder aggregateField(EventAggregateField aggregateField)

The only currently supported value is eventTypeCategory.

Parameters:

aggregateField - The only currently supported value is eventTypeCategory.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EventAggregateField, EventAggregateField

maxResults

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

nextToken

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

requestOverrideConfig

DescribeEventAggregatesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeEventAggregatesRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.