Interface ConnectorConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>, SdkBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>, SdkPojo

Enclosing class:

ConnectorConfiguration

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

Method Summary

Modifier and Type	Method	Description
ConnectorConfiguration.Builder	description(String description)	An agent-facing description override for this tool.
ConnectorConfiguration.Builder	name(String name)	The tool or operation name (for example, retrieve or webSearch).
ConnectorConfiguration.Builder	parameterOverrides(Collection<ConnectorParameterOverride> parameterOverrides)	Parameters to expose to the agent at runtime, with optional description overrides.
ConnectorConfiguration.Builder	parameterOverrides(Consumer<ConnectorParameterOverride.Builder>... parameterOverrides)	Parameters to expose to the agent at runtime, with optional description overrides.
ConnectorConfiguration.Builder	parameterOverrides(ConnectorParameterOverride... parameterOverrides)	Parameters to expose to the agent at runtime, with optional description overrides.
ConnectorConfiguration.Builder	parameterValues(Document parameterValues)	Parameters to set as fixed or default values when provisioning this tool.

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

name

ConnectorConfiguration.Builder name(String name)

The tool or operation name (for example, retrieve or webSearch).

Parameters:

name - The tool or operation name (for example, retrieve or webSearch).

Returns:

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

description

ConnectorConfiguration.Builder description(String description)

An agent-facing description override for this tool.

Parameters:

description - An agent-facing description override for this tool.

Returns:

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

parameterValues

ConnectorConfiguration.Builder parameterValues(Document parameterValues)

Parameters to set as fixed or default values when provisioning this tool.

Parameters:

parameterValues - Parameters to set as fixed or default values when provisioning this tool.

Returns:

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

parameterOverrides

ConnectorConfiguration.Builder parameterOverrides(Collection<ConnectorParameterOverride> parameterOverrides)

Parameters to expose to the agent at runtime, with optional description overrides.

Parameters:

parameterOverrides - Parameters to expose to the agent at runtime, with optional description overrides.

Returns:

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

parameterOverrides

ConnectorConfiguration.Builder parameterOverrides(ConnectorParameterOverride... parameterOverrides)

Parameters to expose to the agent at runtime, with optional description overrides.

Parameters:

parameterOverrides - Parameters to expose to the agent at runtime, with optional description overrides.

Returns:

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

parameterOverrides

ConnectorConfiguration.Builder parameterOverrides(Consumer<ConnectorParameterOverride.Builder>... parameterOverrides)

Parameters to expose to the agent at runtime, with optional description overrides.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterOverrides(List<ConnectorParameterOverride>).

Parameters:

parameterOverrides - a consumer that will call methods on ConnectorParameterOverride.Builder

Returns:

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

See Also:

• parameterOverrides(java.util.Collection<ConnectorParameterOverride>)