Interface CreateDataSourceRequest.Builder

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

  • Method Details

    • clientToken

      CreateDataSourceRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataDeletionPolicy

      CreateDataSourceRequest.Builder dataDeletionPolicy(String dataDeletionPolicy)

      The data deletion policy for the data source.

      You can set the data deletion policy to:

      • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

      • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

      Parameters:
      dataDeletionPolicy - The data deletion policy for the data source.

      You can set the data deletion policy to:

      • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

      • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

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

    • dataDeletionPolicy

      CreateDataSourceRequest.Builder dataDeletionPolicy(DataDeletionPolicy dataDeletionPolicy)

      The data deletion policy for the data source.

      You can set the data deletion policy to:

      • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

      • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

      Parameters:
      dataDeletionPolicy - The data deletion policy for the data source.

      You can set the data deletion policy to:

      • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

      • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

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

    • dataSourceConfiguration

      CreateDataSourceRequest.Builder dataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)

      The connection configuration for the data source.

      Parameters:
      dataSourceConfiguration - The connection configuration for the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceConfiguration

      default CreateDataSourceRequest.Builder dataSourceConfiguration(Consumer<DataSourceConfiguration.Builder> dataSourceConfiguration)

      The connection configuration for the data source.

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

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

      Parameters:
      dataSourceConfiguration - a consumer that will call methods on DataSourceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateDataSourceRequest.Builder description(String description)

      A description of the data source.

      Parameters:
      description - A description of the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseId

      CreateDataSourceRequest.Builder knowledgeBaseId(String knowledgeBaseId)

      The unique identifier of the knowledge base to which to add the data source.

      Parameters:
      knowledgeBaseId - The unique identifier of the knowledge base to which to add the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateDataSourceRequest.Builder name(String name)

      The name of the data source.

      Parameters:
      name - The name of the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverSideEncryptionConfiguration

      CreateDataSourceRequest.Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

      Contains details about the server-side encryption for the data source.

      Parameters:
      serverSideEncryptionConfiguration - Contains details about the server-side encryption for the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverSideEncryptionConfiguration

      default CreateDataSourceRequest.Builder serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)

      Contains details about the server-side encryption for the data source.

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

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

      Parameters:
      serverSideEncryptionConfiguration - a consumer that will call methods on ServerSideEncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vectorIngestionConfiguration

      CreateDataSourceRequest.Builder vectorIngestionConfiguration(VectorIngestionConfiguration vectorIngestionConfiguration)

      Contains details about how to ingest the documents in the data source.

      Parameters:
      vectorIngestionConfiguration - Contains details about how to ingest the documents in the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectorIngestionConfiguration

      default CreateDataSourceRequest.Builder vectorIngestionConfiguration(Consumer<VectorIngestionConfiguration.Builder> vectorIngestionConfiguration)

      Contains details about how to ingest the documents in the data source.

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

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

      Parameters:
      vectorIngestionConfiguration - a consumer that will call methods on VectorIngestionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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