Interface CheckDocumentAccessRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CheckDocumentAccessRequest.Builder,CheckDocumentAccessRequest>, QBusinessRequest.Builder, SdkBuilder<CheckDocumentAccessRequest.Builder,CheckDocumentAccessRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CheckDocumentAccessRequest
@Mutable @NotThreadSafe public static interface CheckDocumentAccessRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CheckDocumentAccessRequest.Builder,CheckDocumentAccessRequest>

  • Method Details

    • applicationId

      CheckDocumentAccessRequest.Builder applicationId(String applicationId)

      The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.

      Parameters:
      applicationId - The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexId

      CheckDocumentAccessRequest.Builder indexId(String indexId)

      The unique identifier of the index. Used to locate the correct index within the application where the document is stored.

      Parameters:
      indexId - The unique identifier of the index. Used to locate the correct index within the application where the document is stored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      CheckDocumentAccessRequest.Builder userId(String userId)

      The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.

      Parameters:
      userId - The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentId

      CheckDocumentAccessRequest.Builder documentId(String documentId)

      The unique identifier of the document. Specifies which document's access permissions are being checked.

      Parameters:
      documentId - The unique identifier of the document. Specifies which document's access permissions are being checked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceId

      CheckDocumentAccessRequest.Builder dataSourceId(String dataSourceId)

      The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.

      Parameters:
      dataSourceId - The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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