Resource: Backend
A backend is the primary resource of App Hosting.
JSON representation |
---|
{ "name": string, "displayName": string, "servingLocality": enum ( |
Fields | |
---|---|
name |
Identifier. The resource name of the backend. Format:
|
displayName |
Optional. Human-readable name. 63 character limit. |
servingLocality |
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). |
codebase |
Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. |
uri |
Output only. The primary URI to communicate with the backend. |
managedResources[] |
Output only. A list of the resources managed by this backend. |
serviceAccount |
Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.googleapis.com/computeRunner or equivalent permissions. |
appId |
Optional. The ID of a Web App associated with the backend. |
environment |
Optional. The environment name of the backend, used to load environment variables from environment specific configuration. |
reconciling |
Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. |
createTime |
Output only. Time at which the backend was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Time at which the backend was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deleteTime |
Output only. Time at which the backend was deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Unstructured key value map that can be used to organize and categorize objects. An object containing a list of |
annotations |
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. An object containing a list of |
uid |
Output only. System-assigned, unique identifier. |
etag |
Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. |
ServingLocality
Specifies how App Hosting replicates and serves your backend's data.
Enums | |
---|---|
SERVING_LOCALITY_UNSPECIFIED |
Unspecified. Will return an error if used. |
REGIONAL_STRICT |
In this mode, App Hosting serves your backend's content from your chosen parent region. App Hosting only maintains data and serving infrastructure in that chosen region and does not replicate your data to other regions. |
GLOBAL_ACCESS |
In this mode, App Hosting serves your backend's content from multiple points-of-presence (POP) across the globe. App Hosting replicates your backend's configuration and cached data to these POPs and uses a global CDN to further decrease response latency. App Hosting-maintained Cloud Resources on your project, such as Cloud Run services, Cloud Build build, and Artifact Registry Images are still confined to your backend's parent region. Responses cached by the CDN may be stored in the POPs for the duration of the cache's TTL. |
Codebase
The connection to an external source repository to watch for event-driven updates to the backend.
JSON representation |
---|
{ "repository": string, "rootDirectory": string } |
Fields | |
---|---|
repository |
Required. The resource name for the Developer Connect projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink} The connection for the |
rootDirectory |
Optional. If |
ManagedResource
An external resource managed by App Hosting on the project.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
runService |
A Cloud Run |
RunService
A managed Cloud Run service
.
JSON representation |
---|
{ "service": string } |
Fields | |
---|---|
service |
Optional. The name of the Cloud Run projects/{project}/locations/{location}/services/{serviceId} |
Methods |
|
---|---|
|
Creates a new backend in a given project and location. |
|
Deletes a single backend. |
|
Gets information about a backend. |
|
Gets information about a backend's traffic. |
|
Lists backends in a given project and location. |
|
Updates the information for a single backend. |
|
Updates a backend's traffic. |