Interface DescribeEventsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>,HealthRequest.Builder,SdkBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- DescribeEventsRequest
public static interface DescribeEventsRequest.Builder extends HealthRequest.Builder, SdkPojo, CopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default DescribeEventsRequest.Builderfilter(Consumer<EventFilter.Builder> filter)Values to narrow the results returned.DescribeEventsRequest.Builderfilter(EventFilter filter)Values to narrow the results returned.DescribeEventsRequest.Builderlocale(String locale)The locale (language) to return information in.DescribeEventsRequest.BuildermaxResults(Integer maxResults)The maximum number of items to return in one batch, between 10 and 100, inclusive.DescribeEventsRequest.BuildernextToken(String nextToken)If the results of a search are large, only a portion of the results are returned, and anextTokenpagination token is returned in the response.DescribeEventsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)DescribeEventsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.health.model.HealthRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
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 theEventFilter.Builderavoiding the need to create one manually viaEventFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilter(EventFilter).- Parameters:
filter- a consumer that will call methods onEventFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filter(EventFilter)
-
nextToken
DescribeEventsRequest.Builder nextToken(String nextToken)
If the results of a search are large, only a portion of the results are returned, and a
nextTokenpagination 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 anextTokenpagination 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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-