Class CreateIndexRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3vectors.model.S3VectorsRequest
software.amazon.awssdk.services.s3vectors.model.CreateIndexRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateIndexRequest extends S3VectorsRequest implements ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

  • Method Details

    • vectorBucketName

      public final String vectorBucketName()

      The name of the vector bucket to create the vector index in.

      Returns:
      The name of the vector bucket to create the vector index in.

    • vectorBucketArn

      public final String vectorBucketArn()

      The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

      Returns:
      The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

    • indexName

      public final String indexName()

      The name of the vector index to create.

      Returns:
      The name of the vector index to create.

    • dataType

      public final DataType dataType()

      The data type of the vectors to be inserted into the vector index.

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

      Returns:
      The data type of the vectors to be inserted into the vector index.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The data type of the vectors to be inserted into the vector index.

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

      Returns:
      The data type of the vectors to be inserted into the vector index.
      See Also:

    • dimension

      public final Integer dimension()

      The dimensions of the vectors to be inserted into the vector index.

      Returns:
      The dimensions of the vectors to be inserted into the vector index.

    • distanceMetric

      public final DistanceMetric distanceMetric()

      The distance metric to be used for similarity search.

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

      Returns:
      The distance metric to be used for similarity search.
      See Also:

    • distanceMetricAsString

      public final String distanceMetricAsString()

      The distance metric to be used for similarity search.

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

      Returns:
      The distance metric to be used for similarity search.
      See Also:

    • metadataConfiguration

      public final MetadataConfiguration metadataConfiguration()

      The metadata configuration for the vector index.

      Returns:
      The metadata configuration for the vector index.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

      Returns:
      The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

      You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

      You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

    • toBuilder

      public CreateIndexRequest.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<CreateIndexRequest.Builder,CreateIndexRequest>
      Specified by:
      toBuilder in class S3VectorsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateIndexRequest.Builder builder()

    • serializableBuilderClass

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