Package com.hashicorp.cdktf.providers.google.firestore_index

Interface FirestoreIndexFields

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FirestoreIndexFields.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FirestoreIndexFields.Builder	builder()
default String	getArrayConfig()	Indicates that this field supports operations on arrayValues.
default String	getFieldPath()	Name of the field.
default String	getOrder()	Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
default FirestoreIndexFieldsVectorConfig	getVectorConfig()	vector_config block.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArrayConfig

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

Indicates that this field supports operations on arrayValues.

Only one of 'order', 'arrayConfig', and 'vectorConfig' can be specified. Possible values: ["CONTAINS"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#array_config FirestoreIndex#array_config}

getFieldPath

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

Name of the field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#field_path FirestoreIndex#field_path}

getOrder

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

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.

Only one of 'order', 'arrayConfig', and 'vectorConfig' can be specified. Possible values: ["ASCENDING", "DESCENDING"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#order FirestoreIndex#order}

getVectorConfig

@Stability(Stable)
@Nullable
default FirestoreIndexFieldsVectorConfig getVectorConfig()

vector_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#vector_config FirestoreIndex#vector_config}

builder

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

Returns:

a FirestoreIndexFields.Builder of FirestoreIndexFields