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

Class VertexAiIndex.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static VertexAiIndex.Builder create​(software.constructs.Construct scope,
                                           String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of VertexAiIndex.Builder.

      • connection

        @Stability(Experimental)
public VertexAiIndex.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public VertexAiIndex.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public VertexAiIndex.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public VertexAiIndex.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public VertexAiIndex.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public VertexAiIndex.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public VertexAiIndex.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public VertexAiIndex.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public VertexAiIndex.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public VertexAiIndex.Builder displayName​(String displayName)
        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}

        Parameters:
        displayName - The display name of the Index. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public VertexAiIndex.Builder description​(String description)
        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}

        Parameters:
        description - The description of the Index. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public VertexAiIndex.Builder id​(String id)
        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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#id VertexAiIndex#id}. This parameter is required.
        Returns:
        this

      • indexUpdateMethod

        @Stability(Stable)
public VertexAiIndex.Builder indexUpdateMethod​(String indexUpdateMethod)
        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}

        Parameters:
        indexUpdateMethod - The update method to use with this Index. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public VertexAiIndex.Builder labels​(Map<String,​String> labels)
        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}

        Parameters:
        labels - The labels with user-defined metadata to organize your Indexes. This parameter is required.
        Returns:
        this

      • metadata

        @Stability(Stable)
public VertexAiIndex.Builder metadata​(VertexAiIndexMetadata metadata)
        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}

        Parameters:
        metadata - metadata block. This parameter is required.
        Returns:
        this

      • project

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

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#project VertexAiIndex#project}. This parameter is required.
        Returns:
        this

      • region

        @Stability(Stable)
public VertexAiIndex.Builder region​(String region)
        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}

        Parameters:
        region - The region of the index. eg us-central1. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public VertexAiIndex.Builder timeouts​(VertexAiIndexTimeouts timeouts)
        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}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this