Package software.amazon.awssdk.services.qbusiness.model

Interface UpdateRetrieverRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateRetrieverRequest.Builder,UpdateRetrieverRequest>, QBusinessRequest.Builder, SdkBuilder<UpdateRetrieverRequest.Builder,UpdateRetrieverRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateRetrieverRequest

public static interface UpdateRetrieverRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<UpdateRetrieverRequest.Builder,UpdateRetrieverRequest>

Method Summary

Modifier and Type	Method	Description
UpdateRetrieverRequest.Builder	applicationId(String applicationId)	The identifier of your Amazon Q Business application.
default UpdateRetrieverRequest.Builder	configuration(Consumer<RetrieverConfiguration.Builder> configuration)	Sets the value of the Configuration property for this object.
UpdateRetrieverRequest.Builder	configuration(RetrieverConfiguration configuration)	Sets the value of the Configuration property for this object.
UpdateRetrieverRequest.Builder	displayName(String displayName)	The name of your retriever.
UpdateRetrieverRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateRetrieverRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateRetrieverRequest.Builder	retrieverId(String retrieverId)	The identifier of your retriever.
UpdateRetrieverRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

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.qbusiness.model.QBusinessRequest.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 Details

applicationId

UpdateRetrieverRequest.Builder applicationId(String applicationId)

The identifier of your Amazon Q Business application.

Parameters:

applicationId - The identifier of your Amazon Q Business application.

Returns:

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

retrieverId

UpdateRetrieverRequest.Builder retrieverId(String retrieverId)

The identifier of your retriever.

Parameters:

retrieverId - The identifier of your retriever.

Returns:

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

configuration

UpdateRetrieverRequest.Builder configuration(RetrieverConfiguration configuration)

Sets the value of the Configuration property for this object.

Parameters:

configuration - The new value for the Configuration property for this object.

Returns:

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

configuration

default UpdateRetrieverRequest.Builder configuration(Consumer<RetrieverConfiguration.Builder> configuration)

Sets the value of the Configuration property for this object. This is a convenience method that creates an instance of the RetrieverConfiguration.Builder avoiding the need to create one manually via RetrieverConfiguration.builder().

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

Parameters:

configuration - a consumer that will call methods on RetrieverConfiguration.Builder

Returns:

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

See Also:

• configuration(RetrieverConfiguration)

displayName

UpdateRetrieverRequest.Builder displayName(String displayName)

The name of your retriever.

Parameters:

displayName - The name of your retriever.

Returns:

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

roleArn

UpdateRetrieverRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

Returns:

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

overrideConfiguration

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

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