Class FirestoreDocumentConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.firestore_document.FirestoreDocumentConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<FirestoreDocumentConfig>
- Enclosing interface:
- FirestoreDocumentConfig
@Stability(Stable) public static final class FirestoreDocumentConfig.Builder extends Object implements software.amazon.jsii.Builder<FirestoreDocumentConfig>
A builder forFirestoreDocumentConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FirestoreDocumentConfigbuild()Builds the configured instance.FirestoreDocumentConfig.Buildercollection(String collection)Sets the value ofFirestoreDocumentConfig.getCollection()FirestoreDocumentConfig.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)Sets the value ofTerraformMetaArguments.getConnection()FirestoreDocumentConfig.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)Sets the value ofTerraformMetaArguments.getConnection()FirestoreDocumentConfig.Buildercount(com.hashicorp.cdktf.TerraformCount count)Sets the value ofTerraformMetaArguments.getCount()FirestoreDocumentConfig.Buildercount(Number count)Sets the value ofTerraformMetaArguments.getCount()FirestoreDocumentConfig.Builderdatabase(String database)Sets the value ofFirestoreDocumentConfig.getDatabase()FirestoreDocumentConfig.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)Sets the value ofTerraformMetaArguments.getDependsOn()FirestoreDocumentConfig.BuilderdocumentId(String documentId)Sets the value ofFirestoreDocumentConfig.getDocumentId()FirestoreDocumentConfig.Builderfields(String fields)Sets the value ofFirestoreDocumentConfig.getFields()FirestoreDocumentConfig.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)Sets the value ofTerraformMetaArguments.getForEach()FirestoreDocumentConfig.Builderid(String id)Sets the value ofFirestoreDocumentConfig.getId()FirestoreDocumentConfig.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)Sets the value ofTerraformMetaArguments.getLifecycle()FirestoreDocumentConfig.Builderproject(String project)Sets the value ofFirestoreDocumentConfig.getProject()FirestoreDocumentConfig.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)Sets the value ofTerraformMetaArguments.getProvider()FirestoreDocumentConfig.Builderprovisioners(List<? extends Object> provisioners)Sets the value ofTerraformMetaArguments.getProvisioners()FirestoreDocumentConfig.Buildertimeouts(FirestoreDocumentTimeouts timeouts)Sets the value ofFirestoreDocumentConfig.getTimeouts()
-
-
-
Method Detail
-
collection
@Stability(Stable) public FirestoreDocumentConfig.Builder collection(String collection)
Sets the value ofFirestoreDocumentConfig.getCollection()- Parameters:
collection- The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#collection FirestoreDocument#collection}- Returns:
this
-
documentId
@Stability(Stable) public FirestoreDocumentConfig.Builder documentId(String documentId)
Sets the value ofFirestoreDocumentConfig.getDocumentId()- Parameters:
documentId- The client-assigned document ID to use for this document during creation. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#document_id FirestoreDocument#document_id}- Returns:
this
-
fields
@Stability(Stable) public FirestoreDocumentConfig.Builder fields(String fields)
Sets the value ofFirestoreDocumentConfig.getFields()- Parameters:
fields- The document's fields formated as a json string. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#fields FirestoreDocument#fields}- Returns:
this
-
database
@Stability(Stable) public FirestoreDocumentConfig.Builder database(String database)
Sets the value ofFirestoreDocumentConfig.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_document#database FirestoreDocument#database}- Returns:
this
-
id
@Stability(Stable) public FirestoreDocumentConfig.Builder id(String id)
Sets the value ofFirestoreDocumentConfig.getId()- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#id FirestoreDocument#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 FirestoreDocumentConfig.Builder project(String project)
Sets the value ofFirestoreDocumentConfig.getProject()- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#project FirestoreDocument#project}.- Returns:
this
-
timeouts
@Stability(Stable) public FirestoreDocumentConfig.Builder timeouts(FirestoreDocumentTimeouts timeouts)
Sets the value ofFirestoreDocumentConfig.getTimeouts()- Parameters:
timeouts- timeouts block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#timeouts FirestoreDocument#timeouts}- Returns:
this
-
connection
@Stability(Experimental) public FirestoreDocumentConfig.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 FirestoreDocumentConfig.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 FirestoreDocumentConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public FirestoreDocumentConfig.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 FirestoreDocumentConfig.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 FirestoreDocumentConfig.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 FirestoreDocumentConfig.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 FirestoreDocumentConfig.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 FirestoreDocumentConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public FirestoreDocumentConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<FirestoreDocumentConfig>- Returns:
- a new instance of
FirestoreDocumentConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-