Package com.hashicorp.cdktf.providers.google.datastore_index

Interface DatastoreIndexConfig

All Superinterfaces:

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

All Known Implementing Classes:

DatastoreIndexConfig.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DatastoreIndexConfig.Builder	builder()
default String	getAncestor()	Policy for including ancestors in the index.
default String	getId()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/datastore_index#id DatastoreIndex#id}.
String	getKind()	The entity kind which the index applies to.
default String	getProject()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/datastore_index#project DatastoreIndex#project}.
default Object	getProperties()	properties block.
default DatastoreIndexTimeouts	getTimeouts()	timeouts block.

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

getKind

@Stability(Stable)
@NotNull
String getKind()

The entity kind which the index applies to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/datastore_index#kind DatastoreIndex#kind}

getAncestor

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

Policy for including ancestors in the index. Default value: "NONE" Possible values: ["NONE", "ALL_ANCESTORS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/datastore_index#ancestor DatastoreIndex#ancestor}

getId

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/datastore_index#id DatastoreIndex#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/resources/datastore_index#project DatastoreIndex#project}.

getProperties

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

properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/datastore_index#properties DatastoreIndex#properties}

getTimeouts

@Stability(Stable)
@Nullable
default DatastoreIndexTimeouts getTimeouts()

timeouts block.

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

builder

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

Returns:

a DatastoreIndexConfig.Builder of DatastoreIndexConfig