Package software.amazon.awssdk.services.health.model

Interface DescribeAffectedEntitiesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeAffectedEntitiesRequest.Builder,DescribeAffectedEntitiesRequest>, HealthRequest.Builder, SdkBuilder<DescribeAffectedEntitiesRequest.Builder,DescribeAffectedEntitiesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeAffectedEntitiesRequest

public static interface DescribeAffectedEntitiesRequest.Builder
extends HealthRequest.Builder, SdkPojo, CopyableBuilder<DescribeAffectedEntitiesRequest.Builder,DescribeAffectedEntitiesRequest>

Method Summary

Modifier and Type	Method	Description
default DescribeAffectedEntitiesRequest.Builder	filter(Consumer<EntityFilter.Builder> filter)	Values to narrow the results returned.
DescribeAffectedEntitiesRequest.Builder	filter(EntityFilter filter)	Values to narrow the results returned.
DescribeAffectedEntitiesRequest.Builder	locale(String locale)	The locale (language) to return information in.
DescribeAffectedEntitiesRequest.Builder	maxResults(Integer maxResults)	The maximum number of items to return in one batch, between 10 and 100, inclusive.
DescribeAffectedEntitiesRequest.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.
DescribeAffectedEntitiesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeAffectedEntitiesRequest.Builder	overrideConfiguration(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

DescribeAffectedEntitiesRequest.Builder filter(EntityFilter filter)

Values to narrow the results returned. At least one event ARN is required.

Parameters:

filter - Values to narrow the results returned. At least one event ARN is required.

Returns:

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

filter

default DescribeAffectedEntitiesRequest.Builder filter(Consumer<EntityFilter.Builder> filter)

Values to narrow the results returned. At least one event ARN is required.

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

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

Parameters:

filter - a consumer that will call methods on EntityFilter.Builder

Returns:

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

See Also:

filter(EntityFilter)

locale

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

nextToken

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

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

overrideConfiguration

DescribeAffectedEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeAffectedEntitiesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder