Class RdsFieldMapping

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.RdsFieldMapping
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RdsFieldMapping.Builder,RdsFieldMapping>
@Generated("software.amazon.awssdk:codegen") public final class RdsFieldMapping extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RdsFieldMapping.Builder,RdsFieldMapping>

Contains the names of the fields to which to map information about the vector store.

See Also:

  • Method Details

    • primaryKeyField

      public final String primaryKeyField()

      The name of the field in which Amazon Bedrock stores the ID for each entry.

      Returns:
      The name of the field in which Amazon Bedrock stores the ID for each entry.

    • vectorField

      public final String vectorField()

      The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

      Returns:
      The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

    • textField

      public final String textField()

      The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

      Returns:
      The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

    • metadataField

      public final String metadataField()

      The name of the field in which Amazon Bedrock stores metadata about the vector store.

      Returns:
      The name of the field in which Amazon Bedrock stores metadata about the vector store.

    • customMetadataField

      public final String customMetadataField()

      Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.

      Returns:
      Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.

    • toBuilder

      public RdsFieldMapping.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<RdsFieldMapping.Builder,RdsFieldMapping>
      Returns:
      a builder for type T

    • builder

      public static RdsFieldMapping.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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