Package com.oracle.database.selectai.model

Class VectorIndexConfig

java.lang.Object
com.oracle.database.selectai.model.VectorIndexConfig
public final class VectorIndexConfig extends Object
Create-time configuration for DBMS_CLOUD_AI.CREATE_VECTOR_INDEX.

This model represents the procedure parameters index_name, attributes, status, description, and wait_for_completion. The attributes payload is represented by VectorIndexAttributes and may be left unset so database-side defaults or validation can apply.

See Also:

  • Method Details

    • getIndexName

      public String getIndexName()
      Returns the vector index name.
      Returns:
      configured vector index name

    • getVectorIndexAttributes

      public VectorIndexAttributes getVectorIndexAttributes()
      Returns the vector index attribute payload.
      Returns:
      vector index attributes payload, or null when unset

    • getStatus

      public VectorIndexConfig.Status getStatus()
      Returns the initial status enum.
      Returns:
      configured status enum

    • getStatusValue

      public String getStatusValue()
      Returns the DBMS_CLOUD_AI status value.
      Returns:
      status display value, or null when status is null

    • getDescription

      public String getDescription()
      Returns the vector index description.
      Returns:
      description, or null when unset

    • isWaitForCompletion

      public Boolean isWaitForCompletion()
      Returns whether create should wait for completion.
      Returns:
      wait-for-completion flag

    • builder

      public static VectorIndexConfig.Builder builder(String indexName)
      Creates a builder for the required vector index name.

      The SDK trims the supplied name and validates only that it is present. Database identifier length and naming rules are validated by DBMS_CLOUD_AI.CREATE_VECTOR_INDEX.

      Parameters:
      indexName - vector index name
      Returns:
      builder initialized with normalized index name