Interface ListDocumentsRequest.Builder

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

  • Method Details

    • applicationId

      ListDocumentsRequest.Builder applicationId(String applicationId)

      The identifier of the application id the documents are attached to.

      Parameters:
      applicationId - The identifier of the application id the documents are attached to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexId

      ListDocumentsRequest.Builder indexId(String indexId)

      The identifier of the index the documents are attached to.

      Parameters:
      indexId - The identifier of the index the documents are attached to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceIds

      ListDocumentsRequest.Builder dataSourceIds(Collection<String> dataSourceIds)

      The identifier of the data sources the documents are attached to.

      Parameters:
      dataSourceIds - The identifier of the data sources the documents are attached to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceIds

      ListDocumentsRequest.Builder dataSourceIds(String... dataSourceIds)

      The identifier of the data sources the documents are attached to.

      Parameters:
      dataSourceIds - The identifier of the data sources the documents are attached to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListDocumentsRequest.Builder nextToken(String nextToken)

      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

      Parameters:
      nextToken - If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListDocumentsRequest.Builder maxResults(Integer maxResults)

      The maximum number of documents to return.

      Parameters:
      maxResults - The maximum number of documents to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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