Package software.amazon.awssdk.services.bedrockagent.model

Class CreateDataSourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.CreateDataSourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDataSourceRequest
extends BedrockAgentRequest
implements ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDataSourceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDataSourceRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
DataDeletionPolicy	dataDeletionPolicy()	The data deletion policy for the data source.
String	dataDeletionPolicyAsString()	The data deletion policy for the data source.
DataSourceConfiguration	dataSourceConfiguration()	The connection configuration for the data source.
String	description()	A description of the data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	knowledgeBaseId()	The unique identifier of the knowledge base to which to add the data source.
String	name()	The name of the data source.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDataSourceRequest.Builder>	serializableBuilderClass()
ServerSideEncryptionConfiguration	serverSideEncryptionConfiguration()	Contains details about the server-side encryption for the data source.
CreateDataSourceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VectorIngestionConfiguration	vectorIngestionConfiguration()	Contains details about how to ingest the documents in the data source.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientToken

public final 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.

Returns:

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.

dataDeletionPolicy

public final 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.

If the service returns an enum value that is not available in the current SDK version, dataDeletionPolicy will return DataDeletionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataDeletionPolicyAsString().

Returns:

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.

See Also:

DataDeletionPolicy

dataDeletionPolicyAsString

public final String dataDeletionPolicyAsString()

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.

If the service returns an enum value that is not available in the current SDK version, dataDeletionPolicy will return DataDeletionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataDeletionPolicyAsString().

Returns:

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.

See Also:

DataDeletionPolicy

dataSourceConfiguration

public final DataSourceConfiguration dataSourceConfiguration()

The connection configuration for the data source.

Returns:

The connection configuration for the data source.

description

public final String description()

A description of the data source.

Returns:

A description of the data source.

knowledgeBaseId

public final String knowledgeBaseId()

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

Returns:

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

name

public final String name()

The name of the data source.

Returns:

The name of the data source.

serverSideEncryptionConfiguration

public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

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

Returns:

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

vectorIngestionConfiguration

public final VectorIngestionConfiguration vectorIngestionConfiguration()

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

Returns:

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

toBuilder

public CreateDataSourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static CreateDataSourceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDataSourceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo