Backend

import type { Backend } from "https://googleapis.deno.dev/v1/firebaseapphosting:v1.ts";

A backend is the primary resource of App Hosting.

interface Backend {

annotations?: {

[key: string]: string;

};

appId?: string;

codebase?: Codebase;

readonly createTime?: Date;

readonly deleteTime?: Date;

displayName?: string;

environment?: string;

readonly etag?: string;

labels?: {

[key: string]: string;

};

readonly managedResources?: ManagedResource[];

mode?: string;

name?: string;

readonly reconciling?: boolean;

serviceAccount?: string;

servingLocality?: "SERVING_LOCALITY_UNSPECIFIED" | "REGIONAL_STRICT" | "GLOBAL_ACCESS";

readonly uid?: string;

readonly updateTime?: Date;

readonly uri?: string;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

appId?: string

[src]

Optional. The ID of a Web App associated with the backend.

codebase?: Codebase

[src]

Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.

readonly createTime?: Date

[src]

Output only. Time at which the backend was created.

readonly deleteTime?: Date

[src]

Output only. Time at which the backend was deleted.

displayName?: string

[src]

Optional. Human-readable name. 63 character limit.

environment?: string

[src]

Optional. The environment name of the backend, used to load environment variables from environment specific configuration.

readonly etag?: string

[src]

Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.

labels?: {

[key: string]: string;

}

[src]

Optional. Unstructured key value map that can be used to organize and categorize objects.

readonly managedResources?: ManagedResource[]

[src]

Output only. A list of the resources managed by this backend.

mode?: string

[src]

Optional. Deprecated: Use environment instead.

name?: string

[src]

Identifier. The resource name of the backend. Format: projects/{project}/locations/{locationId}/backends/{backendId}.

readonly reconciling?: boolean

[src]

Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.

serviceAccount?: string

[src]

Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.

servingLocality?: "SERVING_LOCALITY_UNSPECIFIED" | "REGIONAL_STRICT" | "GLOBAL_ACCESS"

[src]

Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).

readonly uid?: string

[src]

Output only. System-assigned, unique identifier.

readonly updateTime?: Date

[src]

Output only. Time at which the backend was last updated.

readonly uri?: string

[src]

Output only. The primary URI to communicate with the backend.