Skip to main content

@swamp/gcp/firebaseapphosting

v2026.04.23.1

Google Cloud firebaseapphosting infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudfirebaseapphostingcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/firebaseapphosting

@swamp/gcp/firebaseapphosting/backendsv2026.04.23.1backends.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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?stringOptional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
codebase?objectThe connection to an external source repository to watch for event-driven updates to the backend.
displayName?stringOptional. Human-readable name. 63 character limit.
environment?stringOptional. The environment name of the backend, used to load environment variables from environment specific configuration.
labels?recordOptional. Unstructured key value map that can be used to organize and categorize objects.
name?stringIdentifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
requestLogsDisabled?booleanOptional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
serviceAccount?stringRequired. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
servingLocality?enumRequired. 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).
backendId?stringRequired. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backends
getGet a backends
ArgumentTypeDescription
identifierstringThe name of the backends
updateUpdate backends attributes
deleteDelete the backends
ArgumentTypeDescription
identifierstringThe name of the backends
syncSync backends state from GCP

Resources

state(infinite)— A backend is the primary resource of App Hosting.
@swamp/gcp/firebaseapphosting/backends-buildsv2026.04.23.1backends_builds.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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.
config?objectAdditional configuration of the backend for this build.
displayName?stringOptional. Human-readable name. 63 character limit.
labels?recordOptional. Unstructured key value map that can be used to organize and categorize objects.
name?stringIdentifier. The resource name of the build. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.
source?objectThe source for the build.
buildId?stringRequired. Desired ID of the build being created.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a builds
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a builds
ArgumentTypeDescription
identifierstringThe name of the builds
deleteDelete the builds
ArgumentTypeDescription
identifierstringThe name of the builds
syncSync builds state from GCP

Resources

state(infinite)— A single build for a backend, at a specific point codebase reference tag and ...
@swamp/gcp/firebaseapphosting/backends-domainsv2026.04.23.1backends_domains.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. Annotations as key value pairs.
customDomainStatus?objectThe status of a custom domain's linkage to a backend.
disabled?booleanOptional. Whether the domain is disabled. Defaults to false.
displayName?stringOptional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`.
labels?recordOptional. Labels as key value pairs.
name?stringIdentifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`
serve?objectIndicates whether App Hosting will serve content on the domain.
domainId?stringRequired. Id of the domain to create. Must be a valid domain name.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a domains
getGet a domains
ArgumentTypeDescription
identifierstringThe name of the domains
updateUpdate domains attributes
deleteDelete the domains
ArgumentTypeDescription
identifierstringThe name of the domains
syncSync domains state from GCP

Resources

state(infinite)— A domain name that is associated with a backend.
@swamp/gcp/firebaseapphosting/backends-rolloutsv2026.04.23.1backends_rollouts.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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.
build?stringRequired. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.
displayName?stringOptional. Human-readable name. 63 character limit.
error?objectThe `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](https://github.com/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](https://cloud.google.com/apis/design/errors).
labels?recordOptional. Unstructured key value map that can be used to organize and categorize objects.
name?stringIdentifier. The resource name of the rollout. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
rolloutId?stringOptional. Desired ID of the rollout being created.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a rollouts
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
syncSync rollouts state from GCP

Resources

state(infinite)— A single rollout of a build for a backend.
@swamp/gcp/firebaseapphosting/backends-trafficv2026.04.23.1backends_traffic.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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.
createTime?stringOutput only. Time at which the backend was created.
current?objectA list of traffic splits that together represent where traffic is being routed.
etag?stringOutput only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.
labels?recordOptional. Unstructured key value map that can be used to organize and categorize objects.
name?stringIdentifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.
reconciling?booleanOutput only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list.
rolloutPolicy?objectThe policy for how automatic builds and rollouts are triggered and rolled out.
target?objectA list of traffic splits that together represent where traffic is being routed.
uid?stringOutput only. System-assigned, unique identifier.
updateTime?stringOutput only. Time at which the backend was last updated.
getGet a traffic
ArgumentTypeDescription
identifierstringThe name of the traffic
updateUpdate traffic attributes
syncSync traffic state from GCP

Resources

state(infinite)— Controls traffic configuration for the backend.
@swamp/gcp/firebaseapphosting/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.