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

Interface VertexAiIndexEndpointConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    VertexAiIndexEndpointConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.982Z")
@Stability(Stable)
public interface VertexAiIndexEndpointConfig
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_endpoint#display_name VertexAiIndexEndpoint#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_endpoint#description VertexAiIndexEndpoint#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_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.

      • 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_endpoint#labels VertexAiIndexEndpoint#labels}

      • getNetwork

        @Stability(Stable)
@Nullable
default String getNetwork()
        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}

      • getPrivateServiceConnectConfig

        @Stability(Stable)
@Nullable
default VertexAiIndexEndpointPrivateServiceConnectConfig getPrivateServiceConnectConfig()
        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}

      • 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_endpoint#project VertexAiIndexEndpoint#project}.

      • getPublicEndpointEnabled

        @Stability(Stable)
@Nullable
default Object getPublicEndpointEnabled()
        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}

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default VertexAiIndexEndpointTimeouts getTimeouts()
        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}