Interface CheckIngestedDocumentAclRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRuntimeRequest.Builder, Buildable, CopyableBuilder<CheckIngestedDocumentAclRequest.Builder,CheckIngestedDocumentAclRequest>, SdkBuilder<CheckIngestedDocumentAclRequest.Builder,CheckIngestedDocumentAclRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CheckIngestedDocumentAclRequest

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

Method Summary

Modifier and Type	Method	Description
CheckIngestedDocumentAclRequest.Builder	dataSourceId(String dataSourceId)	The unique identifier of the data source that contains the document.
CheckIngestedDocumentAclRequest.Builder	documentId(String documentId)	The unique identifier of the document to check access for.
CheckIngestedDocumentAclRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base that contains the document.
CheckIngestedDocumentAclRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CheckIngestedDocumentAclRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CheckIngestedDocumentAclRequest.Builder	userContext(Consumer<UserContext.Builder> userContext)	The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).
CheckIngestedDocumentAclRequest.Builder	userContext(UserContext userContext)	The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).

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

overrideConfiguration

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

dataSourceId

CheckIngestedDocumentAclRequest.Builder dataSourceId(String dataSourceId)

The unique identifier of the data source that contains the document.

Parameters:

dataSourceId - The unique identifier of the data source that contains the document.

Returns:

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

documentId

CheckIngestedDocumentAclRequest.Builder documentId(String documentId)

The unique identifier of the document to check access for.

Parameters:

documentId - The unique identifier of the document to check access for.

Returns:

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

knowledgeBaseId

CheckIngestedDocumentAclRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base that contains the document.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base that contains the document.

Returns:

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

userContext

CheckIngestedDocumentAclRequest.Builder userContext(UserContext userContext)

The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).

Parameters:

userContext - The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).

Returns:

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

userContext

default CheckIngestedDocumentAclRequest.Builder userContext(Consumer<UserContext.Builder> userContext)

The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).

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

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

Parameters:

userContext - a consumer that will call methods on UserContext.Builder

Returns:

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

See Also:

• userContext(UserContext)

overrideConfiguration

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

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