@pulumi/gcp/firestore/getDocument.js

A Pulumi package for creating and managing Google Cloud Platform resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getDocumentOutput = exports.getDocument = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
 * Reads a document from a Firestore database.
 * See [the official documentation](https://cloud.google.com/firestore/native/docs/)
 * and
 * [API](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/get/).
 *
 * ## Example Usage
 *
 * Retrieve a document from the Firestore database.
 *
 * ```typescript
 * 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",
 * });
 * ```
 */
function getDocument(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("gcp:firestore/getDocument:getDocument", {
        "collection": args.collection,
        "database": args.database,
        "documentId": args.documentId,
        "project": args.project,
    }, opts);
}
exports.getDocument = getDocument;
/**
 * Reads a document from a Firestore database.
 * See [the official documentation](https://cloud.google.com/firestore/native/docs/)
 * and
 * [API](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/get/).
 *
 * ## Example Usage
 *
 * Retrieve a document from the Firestore database.
 *
 * ```typescript
 * 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",
 * });
 * ```
 */
function getDocumentOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("gcp:firestore/getDocument:getDocument", {
        "collection": args.collection,
        "database": args.database,
        "documentId": args.documentId,
        "project": args.project,
    }, opts);
}
exports.getDocumentOutput = getDocumentOutput;
//# sourceMappingURL=getDocument.js.map