Class PutInputVector

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

The attributes of a vector to add to a vector index.

See Also:

  • Method Details

    • key

      public final String key()

      The name of the vector. The key uniquely identifies the vector in a vector index.

      Returns:
      The name of the vector. The key uniquely identifies the vector in a vector index.

    • data

      public final VectorData data()

      The vector data of the vector.

      Vector dimensions must match the dimension count that's configured for the vector index.

      • For the cosine distance metric, zero vectors (vectors containing all zeros) aren't allowed.

      • For both cosine and euclidean distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.

      Returns:
      The vector data of the vector.

      Vector dimensions must match the dimension count that's configured for the vector index.

      • For the cosine distance metric, zero vectors (vectors containing all zeros) aren't allowed.

      • For both cosine and euclidean distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.

    • metadata

      public final Document metadata()

      Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.

      Returns:
      Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.

    • toBuilder

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

    • builder

      public static PutInputVector.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutInputVector.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.