firebaseapphosting/v1 library

Firebase App Hosting API - v1

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.

For more information, see firebase.google.com/docs/app-hosting

Create an instance of FirebaseAppHostingApi to access these resources:

Classes

ArchiveSource
The URI of an storage archive or a signed URL to use as the build source.
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.
BuildSource
The source for the build.
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.
CustomDomainStatus
The status of a custom domain's linkage to a backend.
DnsRecord
A representation of a DNS records for a domain.
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.
Domain
A domain name that is associated with a backend.
EnvironmentVariable
Environment variables for this build.
Error
The container for the rpc status and source for any errors found during the build process.
FirebaseAppHostingApi
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.
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.
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.
ProjectsLocationsBackendsBuildsResource
ProjectsLocationsBackendsDomainsResource
ProjectsLocationsBackendsResource
ProjectsLocationsBackendsRolloutsResource
ProjectsLocationsBackendsTrafficResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsResource
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](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
RunService
A managed Cloud Run [service](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
ServingBehavior
Indicates whether App Hosting will serve content on the domain.
SourceUserMetadata
Metadata for the user who started the build.
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.

Typedefs

CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Location = $Location00
A resource that represents a Google Cloud location.
Status = $Status00
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.