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

Class FirestoreFieldIndexConfigIndexes.Builder

java.lang.Object

com.hashicorp.cdktf.providers.google.firestore_field.FirestoreFieldIndexConfigIndexes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FirestoreFieldIndexConfigIndexes>

Enclosing interface:

FirestoreFieldIndexConfigIndexes

@Stability(Stable)
public static final class FirestoreFieldIndexConfigIndexes.Builder
extends Object
implements software.amazon.jsii.Builder<FirestoreFieldIndexConfigIndexes>

A builder for FirestoreFieldIndexConfigIndexes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FirestoreFieldIndexConfigIndexes.Builder	arrayConfig(String arrayConfig)	Sets the value of FirestoreFieldIndexConfigIndexes.getArrayConfig()
FirestoreFieldIndexConfigIndexes	build()	Builds the configured instance.
FirestoreFieldIndexConfigIndexes.Builder	order(String order)	Sets the value of FirestoreFieldIndexConfigIndexes.getOrder()
FirestoreFieldIndexConfigIndexes.Builder	queryScope(String queryScope)	Sets the value of FirestoreFieldIndexConfigIndexes.getQueryScope()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

arrayConfig

@Stability(Stable)
public FirestoreFieldIndexConfigIndexes.Builder arrayConfig(String arrayConfig)

Sets the value of FirestoreFieldIndexConfigIndexes.getArrayConfig()

Parameters:

arrayConfig - 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}

Returns:

this

order

@Stability(Stable)
public FirestoreFieldIndexConfigIndexes.Builder order(String order)

Sets the value of FirestoreFieldIndexConfigIndexes.getOrder()

Parameters:

order - 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}

Returns:

this

queryScope

@Stability(Stable)
public FirestoreFieldIndexConfigIndexes.Builder queryScope(String queryScope)

Sets the value of FirestoreFieldIndexConfigIndexes.getQueryScope()

Parameters:

queryScope - 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}

Returns:

this

build

@Stability(Stable)
public FirestoreFieldIndexConfigIndexes build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<FirestoreFieldIndexConfigIndexes>

Returns:

a new instance of FirestoreFieldIndexConfigIndexes

Throws:

NullPointerException - if any required attribute was not provided