Class VectorBucket

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

The attributes of a vector bucket.

See Also:

  • Method Details

    • vectorBucketName

      public final String vectorBucketName()

      The name of the vector bucket.

      Returns:
      The name of the vector bucket.

    • vectorBucketArn

      public final String vectorBucketArn()

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

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

    • creationTime

      public final Instant creationTime()

      Date and time when the vector bucket was created.

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

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The encryption configuration for the vector bucket.

      Returns:
      The encryption configuration for the vector bucket.

    • defaultIndexMode

      public final IndexMode defaultIndexMode()

      The mode that is automatically assigned to new vector indexes in the vector bucket. Changing the default index mode doesn't affect existing vector indexes.

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

      Returns:
      The mode that is automatically assigned to new vector indexes in the vector bucket. Changing the default index mode doesn't affect existing vector indexes.
      See Also:

    • defaultIndexModeAsString

      public final String defaultIndexModeAsString()

      The mode that is automatically assigned to new vector indexes in the vector bucket. Changing the default index mode doesn't affect existing vector indexes.

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

      Returns:
      The mode that is automatically assigned to new vector indexes in the vector bucket. Changing the default index mode doesn't affect existing vector indexes.
      See Also:

    • toBuilder

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

    • builder

      public static VectorBucket.Builder builder()

    • serializableBuilderClass

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