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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.