Interface UpdateRetrieverRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateRetrieverRequest.Builder,
,UpdateRetrieverRequest> QBusinessRequest.Builder
,SdkBuilder<UpdateRetrieverRequest.Builder,
,UpdateRetrieverRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateRetrieverRequest
@Mutable
@NotThreadSafe
public static interface UpdateRetrieverRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<UpdateRetrieverRequest.Builder,UpdateRetrieverRequest>
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(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.configuration
(RetrieverConfiguration configuration) Sets the value of the Configuration property for this object.displayName
(String displayName) The name of your retriever.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.retrieverId
(String retrieverId) The identifier of your retriever.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, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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 theRetrieverConfiguration.Builder
avoiding the need to create one manually viaRetrieverConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfiguration(RetrieverConfiguration)
.- Parameters:
configuration
- a consumer that will call methods onRetrieverConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-