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

Interface VertexAiIndexMetadata

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VertexAiIndexMetadata.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VertexAiIndexMetadata.Builder	builder()
default VertexAiIndexMetadataConfig	getConfig()	config block.
String	getContentsDeltaUri()	Allows inserting, updating or deleting the contents of the Matching Engine Index.
default Object	getIsCompleteOverwrite()	If this field is set together with contentsDeltaUri when calling IndexService.UpdateIndex, then existing content of the Index will be replaced by the data from the contentsDeltaUri.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContentsDeltaUri

@Stability(Stable)
@NotNull
String getContentsDeltaUri()

Allows inserting, updating or deleting the contents of the Matching Engine Index.

The string must be a valid Cloud Storage directory path. If this field is set when calling IndexService.UpdateIndex, then no other Index field can be also updated as part of the same call. The expected structure and format of the files this URI points to is described at https://cloud.google.com/vertex-ai/docs/matching-engine/using-matching-engine#input-data-format Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#contents_delta_uri VertexAiIndex#contents_delta_uri}

getConfig

@Stability(Stable)
@Nullable
default VertexAiIndexMetadataConfig getConfig()

config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#config VertexAiIndex#config}

getIsCompleteOverwrite

@Stability(Stable)
@Nullable
default Object getIsCompleteOverwrite()

If this field is set together with contentsDeltaUri when calling IndexService.UpdateIndex, then existing content of the Index will be replaced by the data from the contentsDeltaUri.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index#is_complete_overwrite VertexAiIndex#is_complete_overwrite}

builder

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

Returns:

a VertexAiIndexMetadata.Builder of VertexAiIndexMetadata