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

Class VertexAiIndexConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        @Stability(Stable)
public VertexAiIndexConfig.Builder displayName​(String displayName)
        Sets the value of VertexAiIndexConfig.getDisplayName()
        Parameters:
        displayName - The display name of the Index. This parameter is required. 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}
        Returns:
        this

      • description

        @Stability(Stable)
public VertexAiIndexConfig.Builder description​(String description)
        Sets the value of VertexAiIndexConfig.getDescription()
        Parameters:
        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}
        Returns:
        this

      • id

        @Stability(Stable)
public VertexAiIndexConfig.Builder id​(String id)
        Sets the value of VertexAiIndexConfig.getId()
        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}. 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.
        Returns:
        this

      • indexUpdateMethod

        @Stability(Stable)
public VertexAiIndexConfig.Builder indexUpdateMethod​(String indexUpdateMethod)
        Sets the value of VertexAiIndexConfig.getIndexUpdateMethod()
        Parameters:
        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}
        Returns:
        this

      • labels

        @Stability(Stable)
public VertexAiIndexConfig.Builder labels​(Map<String,​String> labels)
        Sets the value of VertexAiIndexConfig.getLabels()
        Parameters:
        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}
        Returns:
        this

      • project

        @Stability(Stable)
public VertexAiIndexConfig.Builder project​(String project)
        Sets the value of VertexAiIndexConfig.getProject()
        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}.
        Returns:
        this

      • region

        @Stability(Stable)
public VertexAiIndexConfig.Builder region​(String region)
        Sets the value of VertexAiIndexConfig.getRegion()
        Parameters:
        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}
        Returns:
        this

      • connection

        @Stability(Experimental)
public VertexAiIndexConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • connection

        @Stability(Experimental)
public VertexAiIndexConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public VertexAiIndexConfig.Builder count​(Number count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public VertexAiIndexConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public VertexAiIndexConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Sets the value of TerraformMetaArguments.getDependsOn()
        Parameters:
        dependsOn - the value to be set.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public VertexAiIndexConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Sets the value of TerraformMetaArguments.getForEach()
        Parameters:
        forEach - the value to be set.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public VertexAiIndexConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Sets the value of TerraformMetaArguments.getLifecycle()
        Parameters:
        lifecycle - the value to be set.
        Returns:
        this

      • provider

        @Stability(Experimental)
public VertexAiIndexConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Sets the value of TerraformMetaArguments.getProvider()
        Parameters:
        provider - the value to be set.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public VertexAiIndexConfig.Builder provisioners​(List<? extends Object> provisioners)
        Sets the value of TerraformMetaArguments.getProvisioners()
        Parameters:
        provisioners - the value to be set.
        Returns:
        this