Class FirestoreIndexConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.firestore_index.FirestoreIndexConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<FirestoreIndexConfig>
- Enclosing interface:
- FirestoreIndexConfig
@Stability(Stable) public static final class FirestoreIndexConfig.Builder extends Object implements software.amazon.jsii.Builder<FirestoreIndexConfig>
A builder forFirestoreIndexConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FirestoreIndexConfig.BuilderapiScope(String apiScope)Sets the value ofFirestoreIndexConfig.getApiScope()FirestoreIndexConfigbuild()Builds the configured instance.FirestoreIndexConfig.Buildercollection(String collection)Sets the value ofFirestoreIndexConfig.getCollection()FirestoreIndexConfig.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)Sets the value ofTerraformMetaArguments.getConnection()FirestoreIndexConfig.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)Sets the value ofTerraformMetaArguments.getConnection()FirestoreIndexConfig.Buildercount(com.hashicorp.cdktf.TerraformCount count)Sets the value ofTerraformMetaArguments.getCount()FirestoreIndexConfig.Buildercount(Number count)Sets the value ofTerraformMetaArguments.getCount()FirestoreIndexConfig.Builderdatabase(String database)Sets the value ofFirestoreIndexConfig.getDatabase()FirestoreIndexConfig.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)Sets the value ofTerraformMetaArguments.getDependsOn()FirestoreIndexConfig.Builderfields(com.hashicorp.cdktf.IResolvable fields)Sets the value ofFirestoreIndexConfig.getFields()FirestoreIndexConfig.Builderfields(List<? extends FirestoreIndexFields> fields)Sets the value ofFirestoreIndexConfig.getFields()FirestoreIndexConfig.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)Sets the value ofTerraformMetaArguments.getForEach()FirestoreIndexConfig.Builderid(String id)Sets the value ofFirestoreIndexConfig.getId()FirestoreIndexConfig.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)Sets the value ofTerraformMetaArguments.getLifecycle()FirestoreIndexConfig.Builderproject(String project)Sets the value ofFirestoreIndexConfig.getProject()FirestoreIndexConfig.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)Sets the value ofTerraformMetaArguments.getProvider()FirestoreIndexConfig.Builderprovisioners(List<? extends Object> provisioners)Sets the value ofTerraformMetaArguments.getProvisioners()FirestoreIndexConfig.BuilderqueryScope(String queryScope)Sets the value ofFirestoreIndexConfig.getQueryScope()FirestoreIndexConfig.Buildertimeouts(FirestoreIndexTimeouts timeouts)Sets the value ofFirestoreIndexConfig.getTimeouts()
-
-
-
Method Detail
-
collection
@Stability(Stable) public FirestoreIndexConfig.Builder collection(String collection)
Sets the value ofFirestoreIndexConfig.getCollection()- Parameters:
collection- The collection being indexed. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#collection FirestoreIndex#collection}- Returns:
this
-
fields
@Stability(Stable) public FirestoreIndexConfig.Builder fields(com.hashicorp.cdktf.IResolvable fields)
Sets the value ofFirestoreIndexConfig.getFields()- Parameters:
fields- fields block. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#fields FirestoreIndex#fields}- Returns:
this
-
fields
@Stability(Stable) public FirestoreIndexConfig.Builder fields(List<? extends FirestoreIndexFields> fields)
Sets the value ofFirestoreIndexConfig.getFields()- Parameters:
fields- fields block. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#fields FirestoreIndex#fields}- Returns:
this
-
apiScope
@Stability(Stable) public FirestoreIndexConfig.Builder apiScope(String apiScope)
Sets the value ofFirestoreIndexConfig.getApiScope()- Parameters:
apiScope- The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"]. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#api_scope FirestoreIndex#api_scope}- Returns:
this
-
database
@Stability(Stable) public FirestoreIndexConfig.Builder database(String database)
Sets the value ofFirestoreIndexConfig.getDatabase()- Parameters:
database- The Firestore database id. Defaults to '"(default)"'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#database FirestoreIndex#database}- Returns:
this
-
id
@Stability(Stable) public FirestoreIndexConfig.Builder id(String id)
Sets the value ofFirestoreIndexConfig.getId()- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#id FirestoreIndex#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.- Returns:
this
-
project
@Stability(Stable) public FirestoreIndexConfig.Builder project(String project)
Sets the value ofFirestoreIndexConfig.getProject()- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#project FirestoreIndex#project}.- Returns:
this
-
queryScope
@Stability(Stable) public FirestoreIndexConfig.Builder queryScope(String queryScope)
Sets the value ofFirestoreIndexConfig.getQueryScope()- Parameters:
queryScope- The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"]. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#query_scope FirestoreIndex#query_scope}- Returns:
this
-
timeouts
@Stability(Stable) public FirestoreIndexConfig.Builder timeouts(FirestoreIndexTimeouts timeouts)
Sets the value ofFirestoreIndexConfig.getTimeouts()- Parameters:
timeouts- timeouts block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#timeouts FirestoreIndex#timeouts}- Returns:
this
-
connection
@Stability(Experimental) public FirestoreIndexConfig.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
connection
@Stability(Experimental) public FirestoreIndexConfig.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public FirestoreIndexConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public FirestoreIndexConfig.Builder count(com.hashicorp.cdktf.TerraformCount count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
dependsOn
@Stability(Experimental) public FirestoreIndexConfig.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
Sets the value ofTerraformMetaArguments.getDependsOn()- Parameters:
dependsOn- the value to be set.- Returns:
this
-
forEach
@Stability(Experimental) public FirestoreIndexConfig.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
Sets the value ofTerraformMetaArguments.getForEach()- Parameters:
forEach- the value to be set.- Returns:
this
-
lifecycle
@Stability(Experimental) public FirestoreIndexConfig.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
Sets the value ofTerraformMetaArguments.getLifecycle()- Parameters:
lifecycle- the value to be set.- Returns:
this
-
provider
@Stability(Experimental) public FirestoreIndexConfig.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
Sets the value ofTerraformMetaArguments.getProvider()- Parameters:
provider- the value to be set.- Returns:
this
-
provisioners
@Stability(Experimental) public FirestoreIndexConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public FirestoreIndexConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<FirestoreIndexConfig>- Returns:
- a new instance of
FirestoreIndexConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-