Interface InvokeWebSearchRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<InvokeWebSearchRequest.Builder,InvokeWebSearchRequest>, SdkBuilder<InvokeWebSearchRequest.Builder,InvokeWebSearchRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

InvokeWebSearchRequest

@Mutable
@NotThreadSafe
public static interface InvokeWebSearchRequest.Builder
extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<InvokeWebSearchRequest.Builder,InvokeWebSearchRequest>

Method Summary

Modifier and Type	Method	Description
default InvokeWebSearchRequest.Builder	filters(Consumer<WebSearchFilters.Builder> filters)	The filters to apply to the search results.
InvokeWebSearchRequest.Builder	filters(WebSearchFilters filters)	The filters to apply to the search results.
InvokeWebSearchRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return.
InvokeWebSearchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
InvokeWebSearchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
InvokeWebSearchRequest.Builder	searchQuery(String searchQuery)	The text to search for.
InvokeWebSearchRequest.Builder	webSearchId(String webSearchId)	The identifier of the web search tool to invoke.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest.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

webSearchId

InvokeWebSearchRequest.Builder webSearchId(String webSearchId)

The identifier of the web search tool to invoke. The Amazon Web Services-managed web search tool is web-search.v1.

Parameters:

webSearchId - The identifier of the web search tool to invoke. The Amazon Web Services-managed web search tool is web-search.v1.

Returns:

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

searchQuery

InvokeWebSearchRequest.Builder searchQuery(String searchQuery)

The text to search for.

Parameters:

searchQuery - The text to search for.

Returns:

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

maxResults

InvokeWebSearchRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return. Defaults to 25.

Parameters:

maxResults - The maximum number of results to return. Defaults to 25.

Returns:

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

filters

InvokeWebSearchRequest.Builder filters(WebSearchFilters filters)

The filters to apply to the search results.

Parameters:

filters - The filters to apply to the search results.

Returns:

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

filters

default InvokeWebSearchRequest.Builder filters(Consumer<WebSearchFilters.Builder> filters)

The filters to apply to the search results.

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

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

Parameters:

filters - a consumer that will call methods on WebSearchFilters.Builder

Returns:

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

See Also:

• filters(WebSearchFilters)

overrideConfiguration

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

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