Package com.hashicorp.cdktf.providers.google.firestore_document

Class FirestoreDocument.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static FirestoreDocument.Builder create​(software.constructs.Construct scope,
                                               String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of FirestoreDocument.Builder.

      • connection

        @Stability(Experimental)
public FirestoreDocument.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public FirestoreDocument.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public FirestoreDocument.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public FirestoreDocument.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public FirestoreDocument.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public FirestoreDocument.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public FirestoreDocument.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public FirestoreDocument.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • collection

        @Stability(Stable)
public FirestoreDocument.Builder collection​(String collection)
        The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#collection FirestoreDocument#collection}

        Parameters:
        collection - The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. This parameter is required.
        Returns:
        this

      • documentId

        @Stability(Stable)
public FirestoreDocument.Builder documentId​(String documentId)
        The client-assigned document ID to use for this document during creation.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#document_id FirestoreDocument#document_id}

        Parameters:
        documentId - The client-assigned document ID to use for this document during creation. This parameter is required.
        Returns:
        this

      • fields

        @Stability(Stable)
public FirestoreDocument.Builder fields​(String fields)
        The document's fields formated as a json string.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#fields FirestoreDocument#fields}

        Parameters:
        fields - The document's fields formated as a json string. This parameter is required.
        Returns:
        this

      • database

        @Stability(Stable)
public FirestoreDocument.Builder database​(String 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}

        Parameters:
        database - The Firestore database id. Defaults to '"(default)"'. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public FirestoreDocument.Builder id​(String 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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#id FirestoreDocument#id}. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public FirestoreDocument.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#project FirestoreDocument#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_document#project FirestoreDocument#project}. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public FirestoreDocument.Builder timeouts​(FirestoreDocumentTimeouts 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}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this