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

Class FirestoreIndexFields.Builder

java.lang.Object

com.hashicorp.cdktf.providers.google.firestore_index.FirestoreIndexFields.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FirestoreIndexFields>

Enclosing interface:

FirestoreIndexFields

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

A builder for FirestoreIndexFields

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FirestoreIndexFields.Builder	arrayConfig(String arrayConfig)	Sets the value of FirestoreIndexFields.getArrayConfig()
FirestoreIndexFields	build()	Builds the configured instance.
FirestoreIndexFields.Builder	fieldPath(String fieldPath)	Sets the value of FirestoreIndexFields.getFieldPath()
FirestoreIndexFields.Builder	order(String order)	Sets the value of FirestoreIndexFields.getOrder()
FirestoreIndexFields.Builder	vectorConfig(FirestoreIndexFieldsVectorConfig vectorConfig)	Sets the value of FirestoreIndexFields.getVectorConfig()

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 FirestoreIndexFields.Builder arrayConfig(String arrayConfig)

Sets the value of FirestoreIndexFields.getArrayConfig()

Parameters:

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

Returns:

this

fieldPath

@Stability(Stable)
public FirestoreIndexFields.Builder fieldPath(String fieldPath)

Sets the value of FirestoreIndexFields.getFieldPath()

Parameters:

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

Returns:

this

order

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

Sets the value of FirestoreIndexFields.getOrder()

Parameters:

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

Returns:

this

vectorConfig

@Stability(Stable)
public FirestoreIndexFields.Builder vectorConfig(FirestoreIndexFieldsVectorConfig vectorConfig)

Sets the value of FirestoreIndexFields.getVectorConfig()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public FirestoreIndexFields build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of FirestoreIndexFields

Throws:

NullPointerException - if any required attribute was not provided