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

Usage

import * as mod from "https://googleapis.deno.dev/v1/firebaseapphosting:v1.ts";

§Classes

FirebaseAppHosting

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.

GoogleAuth

§Variables

auth

§Interfaces

Backend

A backend is the primary resource of App Hosting.

Build

A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image.

BuildSource

The source for the build.

CancelOperationRequest

The request message for Operations.CancelOperation.

Codebase

The connection to an external source repository to watch for event-driven updates to the backend.

CodebaseSource

A codebase source, representing the state of the codebase that the build will be created at.

Config

Additional configuration of the backend for this build.

ContainerSource

The URI of an Artifact Registry container image to use as the build source.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

CustomDomainOperationMetadata

Additional metadata for operations on custom domains.

CustomDomainStatus

The status of a custom domain's linkage to a backend.

DnsRecord

A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add A records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files).

DnsRecordSet

A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting.

DnsUpdates

A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active.

Domain

A domain name that is associated with a backend.

DomainOperationMetadata

Represents the metadata of a long-running operation on domains.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

EnvironmentVariable

Environment variables for this build.

Error

The container for the rpc status and source for any errors found during the build process.

ListBackendsResponse

Message for response to list backends

ListBuildsResponse

Message for response to list builds.

ListDomainsResponse

Message for response to list domains.

ListLocationsResponse

The response message for Locations.ListLocations.

ListOperationsResponse

The response message for Operations.ListOperations.

ListRolloutsResponse

Message for response to list rollouts.

LiveMigrationStep

A set of updates including ACME challenges and DNS records that allow App Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to App Hosting servers. Use these updates to facilitate zero downtime migrations to App Hosting from other services. After you've made the recommended updates, check your custom domain's ownershipState and certState. To avoid downtime, they should be OWNERSHIP_ACTIVE and CERT_ACTIVE, respectively, before you update your A and AAAA records.

Location

A resource that represents a Google Cloud location.

ManagedResource

An external resource managed by App Hosting on the project.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata

Represents the metadata of a long-running operation.

ProjectsLocationsBackendsBuildsCreateOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsBuildsCreate.

ProjectsLocationsBackendsBuildsDeleteOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsBuildsDelete.

ProjectsLocationsBackendsBuildsListOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsBuildsList.

ProjectsLocationsBackendsCreateOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsCreate.

ProjectsLocationsBackendsDeleteOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsDelete.

ProjectsLocationsBackendsDomainsCreateOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsDomainsCreate.

ProjectsLocationsBackendsDomainsDeleteOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsDomainsDelete.

ProjectsLocationsBackendsDomainsListOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsDomainsList.

ProjectsLocationsBackendsDomainsPatchOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsDomainsPatch.

ProjectsLocationsBackendsListOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsList.

ProjectsLocationsBackendsPatchOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsPatch.

ProjectsLocationsBackendsRolloutsCreateOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsRolloutsCreate.

ProjectsLocationsBackendsRolloutsListOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsRolloutsList.

ProjectsLocationsBackendsTrafficPatchOptions

Additional options for FirebaseAppHosting#projectsLocationsBackendsTrafficPatch.

ProjectsLocationsListOptions

Additional options for FirebaseAppHosting#projectsLocationsList.

ProjectsLocationsOperationsListOptions

Additional options for FirebaseAppHosting#projectsLocationsOperationsList.

Redirect

Specifies redirect behavior for a domain.

Rollout

A single rollout of a build for a backend.

RolloutPolicy

The policy for how automatic builds and rollouts are triggered and rolled out.

RunConfig

Additional configuration to apply to the Cloud Run service.

RunService

A managed Cloud Run service.

ServingBehavior

Indicates whether App Hosting will serve content on the domain.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Traffic

Controls traffic configuration for the backend.

TrafficSet

A list of traffic splits that together represent where traffic is being routed.

TrafficSplit

The traffic allocation for the backend.

UserMetadata

Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user.