Package com.hashicorp.cdktf.providers.google.vertex_ai_index

Interface VertexAiIndexConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    VertexAiIndexConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.977Z")
@Stability(Stable)
public interface VertexAiIndexConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        The display name of the Index.

        The name can be up to 128 characters long and can consist of any UTF-8 characters. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#display_name VertexAiIndex#display_name}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        The description of the Index.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#description VertexAiIndex#description}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#id VertexAiIndex#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getIndexUpdateMethod

        @Stability(Stable)
@Nullable
default String getIndexUpdateMethod()
        The update method to use with this Index.

        The value must be the followings. If not set, BATCH_UPDATE will be used by default. * BATCH_UPDATE: user can call indexes.patch with files on Cloud Storage of datapoints to update. * STREAM_UPDATE: user can call indexes.upsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#index_update_method VertexAiIndex#index_update_method}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        The labels with user-defined metadata to organize your Indexes.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#labels VertexAiIndex#labels}

      • getMetadata

        @Stability(Stable)
@Nullable
default VertexAiIndexMetadata getMetadata()
        metadata block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#metadata VertexAiIndex#metadata}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#project VertexAiIndex#project}.

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        The region of the index. eg us-central1.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#region VertexAiIndex#region}

      • getTimeouts

        @Stability(Stable)
@Nullable
default VertexAiIndexTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#timeouts VertexAiIndex#timeouts}