Class IndexSummary

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

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

Summary information about a vector index.

See Also:

  • Method Details

    • vectorBucketName

      public final String vectorBucketName()

      The name of the vector bucket that contains the vector index.

      Returns:
      The name of the vector bucket that contains the vector index.

    • indexName

      public final String indexName()

      The name of the vector index.

      Returns:
      The name of the vector index.

    • indexArn

      public final String indexArn()

      The Amazon Resource Name (ARN) of the vector index.

      Returns:
      The Amazon Resource Name (ARN) of the vector index.

    • creationTime

      public final Instant creationTime()

      Date and time when the vector index was created.

      Returns:
      Date and time when the vector index was created.

    • toBuilder

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

    • builder

      public static IndexSummary.Builder builder()

    • serializableBuilderClass

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