Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

FirebaseAppHosting

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

Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images.

class FirebaseAppHosting {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsBackendsBuildsCreate(
parent: string,
req: Build,
opts?: ProjectsLocationsBackendsBuildsCreateOptions,
): Promise<Operation>;
async projectsLocationsBackendsBuildsDelete(name: string, opts?: ProjectsLocationsBackendsBuildsDeleteOptions): Promise<Operation>;
async projectsLocationsBackendsBuildsGet(name: string): Promise<Build>;
async projectsLocationsBackendsBuildsList(parent: string, opts?: ProjectsLocationsBackendsBuildsListOptions): Promise<ListBuildsResponse>;
async projectsLocationsBackendsCreate(
parent: string,
req: Backend,
opts?: ProjectsLocationsBackendsCreateOptions,
): Promise<Operation>;
async projectsLocationsBackendsDelete(name: string, opts?: ProjectsLocationsBackendsDeleteOptions): Promise<Operation>;
async projectsLocationsBackendsDomainsCreate(
parent: string,
req: Domain,
opts?: ProjectsLocationsBackendsDomainsCreateOptions,
): Promise<Operation>;
async projectsLocationsBackendsDomainsDelete(name: string, opts?: ProjectsLocationsBackendsDomainsDeleteOptions): Promise<Operation>;
async projectsLocationsBackendsDomainsGet(name: string): Promise<Domain>;
async projectsLocationsBackendsDomainsList(parent: string, opts?: ProjectsLocationsBackendsDomainsListOptions): Promise<ListDomainsResponse>;
async projectsLocationsBackendsDomainsPatch(
name: string,
req: Domain,
opts?: ProjectsLocationsBackendsDomainsPatchOptions,
): Promise<Operation>;
async projectsLocationsBackendsGet(name: string): Promise<Backend>;
async projectsLocationsBackendsList(parent: string, opts?: ProjectsLocationsBackendsListOptions): Promise<ListBackendsResponse>;
async projectsLocationsBackendsPatch(
name: string,
req: Backend,
opts?: ProjectsLocationsBackendsPatchOptions,
): Promise<Operation>;
async projectsLocationsBackendsRolloutsCreate(
parent: string,
req: Rollout,
opts?: ProjectsLocationsBackendsRolloutsCreateOptions,
): Promise<Operation>;
async projectsLocationsBackendsRolloutsGet(name: string): Promise<Rollout>;
async projectsLocationsBackendsRolloutsList(parent: string, opts?: ProjectsLocationsBackendsRolloutsListOptions): Promise<ListRolloutsResponse>;
async projectsLocationsBackendsTrafficGet(name: string): Promise<Traffic>;
async projectsLocationsBackendsTrafficPatch(
name: string,
req: Traffic,
opts?: ProjectsLocationsBackendsTrafficPatchOptions,
): Promise<Operation>;
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;
async projectsLocationsOperationsDelete(name: string): Promise<Empty>;
async projectsLocationsOperationsGet(name: string): Promise<Operation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;
}

§Constructors

§
new FirebaseAppHosting(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsBackendsBuildsCreate(parent: string, req: Build, opts?: ProjectsLocationsBackendsBuildsCreateOptions): Promise<Operation>
[src]

Creates a new build for a backend.

@param parent

Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsBuildsDelete(name: string, opts?: ProjectsLocationsBackendsBuildsDeleteOptions): Promise<Operation>
[src]

Deletes a single build.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}.

§
projectsLocationsBackendsBuildsGet(name: string): Promise<Build>
[src]

Gets information about a build.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}.

§
projectsLocationsBackendsBuildsList(parent: string, opts?: ProjectsLocationsBackendsBuildsListOptions): Promise<ListBuildsResponse>
[src]

Lists builds in a given project, location, and backend.

@param parent

Required. The parent backend in the form projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsCreate(parent: string, req: Backend, opts?: ProjectsLocationsBackendsCreateOptions): Promise<Operation>
[src]

Creates a new backend in a given project and location.

@param parent

Required. A parent name of the form projects/{project}/locations/{locationId}.

§
projectsLocationsBackendsDelete(name: string, opts?: ProjectsLocationsBackendsDeleteOptions): Promise<Operation>
[src]

Deletes a single backend.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsDomainsCreate(parent: string, req: Domain, opts?: ProjectsLocationsBackendsDomainsCreateOptions): Promise<Operation>
[src]

Links a new domain to a backend.

@param parent

Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsDomainsDelete(name: string, opts?: ProjectsLocationsBackendsDomainsDeleteOptions): Promise<Operation>
[src]

Deletes a single domain.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}.

§
projectsLocationsBackendsDomainsGet(name: string): Promise<Domain>
[src]

Gets information about a domain.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}.

§
projectsLocationsBackendsDomainsList(parent: string, opts?: ProjectsLocationsBackendsDomainsListOptions): Promise<ListDomainsResponse>
[src]

Lists domains of a backend.

@param parent

Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsDomainsPatch(name: string, req: Domain, opts?: ProjectsLocationsBackendsDomainsPatchOptions): Promise<Operation>
[src]

Updates the information for a single domain.

@param name

Identifier. The resource name of the domain, e.g. /projects/p/locations/l/backends/b/domains/foo.com

§
projectsLocationsBackendsGet(name: string): Promise<Backend>
[src]

Gets information about a backend.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsList(parent: string, opts?: ProjectsLocationsBackendsListOptions): Promise<ListBackendsResponse>
[src]

Lists backends in a given project and location.

@param parent

Required. A parent name of the form projects/{project}/locations/{locationId}.

§
projectsLocationsBackendsPatch(name: string, req: Backend, opts?: ProjectsLocationsBackendsPatchOptions): Promise<Operation>
[src]

Updates the information for a single backend.

@param name

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

§
projectsLocationsBackendsRolloutsCreate(parent: string, req: Rollout, opts?: ProjectsLocationsBackendsRolloutsCreateOptions): Promise<Operation>
[src]

Creates a new rollout for a backend.

@param parent

Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsRolloutsGet(name: string): Promise<Rollout>
[src]

Gets information about a rollout.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}.

§
projectsLocationsBackendsRolloutsList(parent: string, opts?: ProjectsLocationsBackendsRolloutsListOptions): Promise<ListRolloutsResponse>
[src]

Lists rollouts for a backend.

@param parent

Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

§
projectsLocationsBackendsTrafficGet(name: string): Promise<Traffic>
[src]

Gets information about a backend's traffic.

@param name

Required. Name of the resource in the format: projects/{project}/locations/{locationId}/backends/{backendId}/traffic.

§
projectsLocationsBackendsTrafficPatch(name: string, req: Traffic, opts?: ProjectsLocationsBackendsTrafficPatchOptions): Promise<Operation>
[src]

Updates a backend's traffic.

@param name

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

§
projectsLocationsGet(name: string): Promise<Location>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>
[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsOperationsDelete(name: string): Promise<Empty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsOperationsGet(name: string): Promise<Operation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.