Package com.hashicorp.cdktf.providers.google.firestore_field

Interface FirestoreFieldIndexConfigIndexes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FirestoreFieldIndexConfigIndexes.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FirestoreFieldIndexConfigIndexes.Builder	builder()
default String	getArrayConfig()	Indicates that this field supports operations on arrayValues.
default String	getOrder()	Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=, !=.
default String	getQueryScope()	The scope at which a query is run.

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' and 'arrayConfig' can be specified. Possible values: ["CONTAINS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_field#array_config FirestoreField#array_config}

getOrder

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

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=, !=. Only one of 'order' and 'arrayConfig' 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_field#order FirestoreField#order}

getQueryScope

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

The scope at which a query is run.

Collection scoped queries require you specify the collection at query time. Collection group scope allows queries across all collections with the same id. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_field#query_scope FirestoreField#query_scope}

builder

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

Returns:

a FirestoreFieldIndexConfigIndexes.Builder of FirestoreFieldIndexConfigIndexes