Package com.hashicorp.cdktf.providers.google.data_google_vertex_ai_index

Interface DataGoogleVertexAiIndexConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

All Known Implementing Classes:

DataGoogleVertexAiIndexConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:20.263Z")
@Stability(Stable)
public interface DataGoogleVertexAiIndexConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataGoogleVertexAiIndexConfig.Builder	A builder for DataGoogleVertexAiIndexConfig
static class	DataGoogleVertexAiIndexConfig.Jsii$Proxy	An implementation for DataGoogleVertexAiIndexConfig

Method Summary

Modifier and Type	Method	Description
static DataGoogleVertexAiIndexConfig.Builder	builder()
default String	getId()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/vertex_ai_index#id DataGoogleVertexAiIndex#id}.
String	getName()	The resource name of the Index.
default String	getProject()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/vertex_ai_index#project DataGoogleVertexAiIndex#project}.
String	getRegion()	The region of the index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface com.hashicorp.cdktf.TerraformMetaArguments

getConnection, getCount, getDependsOn, getForEach, getLifecycle, getProvider, getProvisioners

Method Detail

getName

@Stability(Stable)
@NotNull
String getName()

The resource name of the Index.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/vertex_ai_index#name DataGoogleVertexAiIndex#name}

getRegion

@Stability(Stable)
@NotNull
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/data-sources/vertex_ai_index#region DataGoogleVertexAiIndex#region}

getId

@Stability(Stable)
@Nullable
default String getId()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/vertex_ai_index#id DataGoogleVertexAiIndex#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.

getProject

@Stability(Stable)
@Nullable
default String getProject()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/vertex_ai_index#project DataGoogleVertexAiIndex#project}.

builder

@Stability(Stable)
static DataGoogleVertexAiIndexConfig.Builder builder()

Returns:

a DataGoogleVertexAiIndexConfig.Builder of DataGoogleVertexAiIndexConfig