getDocument function

Future<GetDocumentResult> getDocument(GetDocumentArgs args, { InvokeOptions? options, })

Reads a document from a Firestore database. See the official documentation and API.

Example Usage

Retrieve a document from the Firestore database.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const mydoc = new gcp.firestore.Document("mydoc", {
    project: database.project,
    database: database.name,
    collection: "somenewcollection",
    documentId: "my-doc-id",
});

import pulumi
import pulumi_gcp as gcp

mydoc = gcp.firestore.Document("mydoc",
    project=database["project"],
    database=database["name"],
    collection="somenewcollection",
    document_id="my-doc-id")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var mydoc = new Gcp.Firestore.Document("mydoc", new()
    {
        Project = database.Project,
        Database = database.Name,
        Collection = "somenewcollection",
        DocumentId = "my-doc-id",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firestore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firestore.NewDocument(ctx, "mydoc", &firestore.DocumentArgs{
			Project:    pulumi.Any(database.Project),
			Database:   pulumi.Any(database.Name),
			Collection: pulumi.String("somenewcollection"),
			DocumentId: pulumi.String("my-doc-id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_firestore_document" "mydoc" {
  project     = database.project
  database    = database.name
  collection  = "somenewcollection"
  document_id = "my-doc-id"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firestore.Document;
import com.pulumi.gcp.firestore.DocumentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mydoc = new Document("mydoc", DocumentArgs.builder()
            .project(database.get("project"))
            .database(database.get("name"))
            .collection("somenewcollection")
            .documentId("my-doc-id")
            .build());

    }
}

resources:
  mydoc:
    type: gcp:firestore:Document
    properties:
      project: ${database.project}
      database: ${database.name}
      collection: somenewcollection
      documentId: my-doc-id

args Arguments passed to this invoke. Arguments for getDocument. options Invoke options controlling this call.

Implementation

Future<GetDocumentResult> getDocument(
  GetDocumentArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:firestore/getDocument:getDocument',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetDocumentResult.fromMap(result);
}