FirebaseProject

import type { FirebaseProject } from "https://googleapis.deno.dev/v1/firebase:v1beta1.ts";

A FirebaseProject is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a FirebaseProject by calling AddFirebase and specifying an existing GCP Project. This adds Firebase resources to the existing GCP Project. Since a FirebaseProject is actually also a GCP Project, a FirebaseProject has the same underlying GCP identifiers (projectNumber and projectId). This allows for easy interop with Google APIs.

interface FirebaseProject {

annotations?: {

[key: string]: string;

};

displayName?: string;

etag?: string;

name?: string;

readonly projectId?: string;

readonly projectNumber?: bigint;

readonly resources?: DefaultResources;

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

A set of user-defined annotations for the FirebaseProject. Learn more about annotations in Google's AIP-128 standard. These annotations are intended solely for developers and client-side tools. Firebase services will not mutate this annotations set.

displayName?: string

[src]

The user-assigned display name of the Project.

etag?: string

[src]

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

name?: string

[src]

The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId.

readonly projectId?: string

[src]

Output only. Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.

readonly projectNumber?: bigint

[src]

Output only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.

readonly resources?: DefaultResources

[src]

Output only. DEPRECATED. Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve information about each resource directly from its resource-specific API. The default Firebase resources associated with the Project.

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"

[src]

Output only. The lifecycle state of the Project.