Interface SearchMetricsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SearchMetricsRequest.Builder,SearchMetricsRequest>, SdkBuilder<SearchMetricsRequest.Builder,SearchMetricsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchMetricsRequest

@Mutable
@NotThreadSafe
public static interface SearchMetricsRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchMetricsRequest.Builder,SearchMetricsRequest>

Method Summary

Modifier and Type	Method	Description
SearchMetricsRequest.Builder	instanceId(String instanceId)	The identifier of the Connect Customer instance.
SearchMetricsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchMetricsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchMetricsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchMetricsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchMetricsRequest.Builder	searchCriteria(Consumer<MetricSearchCriteria.Builder> searchCriteria)	The search criteria to filter the metrics.
SearchMetricsRequest.Builder	searchCriteria(MetricSearchCriteria searchCriteria)	The search criteria to filter the metrics.
default SearchMetricsRequest.Builder	searchFilter(Consumer<MetricSearchFilter.Builder> searchFilter)	Filters to be applied to search results.
SearchMetricsRequest.Builder	searchFilter(MetricSearchFilter searchFilter)	Filters to be applied to search results.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

instanceId

SearchMetricsRequest.Builder instanceId(String instanceId)

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

nextToken

SearchMetricsRequest.Builder nextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

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

maxResults

SearchMetricsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

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

searchFilter

SearchMetricsRequest.Builder searchFilter(MetricSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter - Filters to be applied to search results.

Returns:

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

searchFilter

default SearchMetricsRequest.Builder searchFilter(Consumer<MetricSearchFilter.Builder> searchFilter)

Filters to be applied to search results.

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

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

Parameters:

searchFilter - a consumer that will call methods on MetricSearchFilter.Builder

Returns:

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

See Also:

• searchFilter(MetricSearchFilter)

searchCriteria

SearchMetricsRequest.Builder searchCriteria(MetricSearchCriteria searchCriteria)

The search criteria to filter the metrics.

Parameters:

searchCriteria - The search criteria to filter the metrics.

Returns:

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

searchCriteria

default SearchMetricsRequest.Builder searchCriteria(Consumer<MetricSearchCriteria.Builder> searchCriteria)

The search criteria to filter the metrics.

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

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

Parameters:

searchCriteria - a consumer that will call methods on MetricSearchCriteria.Builder

Returns:

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

See Also:

• searchCriteria(MetricSearchCriteria)

overrideConfiguration

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

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