Package com.hashicorp.cdktf.providers.google.vertex_ai_index_endpoint

Class VertexAiIndexEndpoint.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static VertexAiIndexEndpoint.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 VertexAiIndexEndpoint.Builder.

      • connection

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

      • connection

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • displayName

        @Stability(Stable)
public VertexAiIndexEndpoint.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_endpoint#display_name VertexAiIndexEndpoint#display_name}

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

      • description

        @Stability(Stable)
public VertexAiIndexEndpoint.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_endpoint#description VertexAiIndexEndpoint#description}

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

      • id

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint#id VertexAiIndexEndpoint#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_endpoint#id VertexAiIndexEndpoint#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public VertexAiIndexEndpoint.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_endpoint#labels VertexAiIndexEndpoint#labels}

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

      • network

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder network​(String network)
        The full name of the Google Compute Engine network to which the index endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. Format: 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint#network VertexAiIndexEndpoint#network}

        Parameters:
        network - The full name of the Google Compute Engine network to which the index endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. Format: 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name. This parameter is required.
        Returns:
        this

      • privateServiceConnectConfig

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder privateServiceConnectConfig​(VertexAiIndexEndpointPrivateServiceConnectConfig privateServiceConnectConfig)
        private_service_connect_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint#private_service_connect_config VertexAiIndexEndpoint#private_service_connect_config}

        Parameters:
        privateServiceConnectConfig - private_service_connect_config block. This parameter is required.
        Returns:
        this

      • project

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

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

      • publicEndpointEnabled

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder publicEndpointEnabled​(Boolean publicEndpointEnabled)
        If true, the deployed index will be accessible through public endpoint.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint#public_endpoint_enabled VertexAiIndexEndpoint#public_endpoint_enabled}

        Parameters:
        publicEndpointEnabled - If true, the deployed index will be accessible through public endpoint. This parameter is required.
        Returns:
        this

      • publicEndpointEnabled

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder publicEndpointEnabled​(com.hashicorp.cdktf.IResolvable publicEndpointEnabled)
        If true, the deployed index will be accessible through public endpoint.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint#public_endpoint_enabled VertexAiIndexEndpoint#public_endpoint_enabled}

        Parameters:
        publicEndpointEnabled - If true, the deployed index will be accessible through public endpoint. This parameter is required.
        Returns:
        this

      • region

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder region​(String region)
        The region of the index endpoint. eg us-central1.

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

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

      • timeouts

        @Stability(Stable)
public VertexAiIndexEndpoint.Builder timeouts​(VertexAiIndexEndpointTimeouts timeouts)
        timeouts block.

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

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