backends

Creates, updates, deletes, gets or lists a backends resource.

Overview

Name	backends
Type	Resource
Id	firebase.apphosting.backends

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the backend. Format: projects/{project}/locations/{locationId}/backends/{backendId}.
annotations	object	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.
appId	string	Optional. The ID of a Web App associated with the backend.
codebase	object	Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. (id: Codebase)
createTime	string (google-datetime)	Output only. Time at which the backend was created.
deleteTime	string (google-datetime)	Output only. Time at which the backend was deleted.
displayName	string	Optional. Human-readable name. 63 character limit.
environment	string	Optional. The environment name of the backend, used to load environment variables from environment specific configuration.
etag	string	Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.
labels	object	Optional. Unstructured key value map that can be used to organize and categorize objects.
managedResources	array	Output only. A list of the resources managed by this backend.
mode	string	Optional. Deprecated: Use environment instead.
reconciling	boolean	Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.
requestLogsDisabled	boolean	Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
serviceAccount	string	Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
servingLocality	string	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). (SERVING_LOCALITY_UNSPECIFIED, REGIONAL_STRICT, GLOBAL_ACCESS)
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. Time at which the backend was last updated.
uri	string	Output only. The primary URI to communicate with the backend.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the backend. Format: projects/{project}/locations/{locationId}/backends/{backendId}.
annotations	object	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.
appId	string	Optional. The ID of a Web App associated with the backend.
codebase	object	Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. (id: Codebase)
createTime	string (google-datetime)	Output only. Time at which the backend was created.
deleteTime	string (google-datetime)	Output only. Time at which the backend was deleted.
displayName	string	Optional. Human-readable name. 63 character limit.
environment	string	Optional. The environment name of the backend, used to load environment variables from environment specific configuration.
etag	string	Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.
labels	object	Optional. Unstructured key value map that can be used to organize and categorize objects.
managedResources	array	Output only. A list of the resources managed by this backend.
mode	string	Optional. Deprecated: Use environment instead.
reconciling	boolean	Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.
requestLogsDisabled	boolean	Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
serviceAccount	string	Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
servingLocality	string	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). (SERVING_LOCALITY_UNSPECIFIED, REGIONAL_STRICT, GLOBAL_ACCESS)
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. Time at which the backend was last updated.
uri	string	Output only. The primary URI to communicate with the backend.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backendsId		Gets information about a backend.
list	select	projectsId, locationsId	pageSize, pageToken, filter, showDeleted, orderBy	Lists backends in a given project and location.
create	insert	projectsId, locationsId	validateOnly, backendId, requestId	Creates a new backend in a given project and location.
patch	update	projectsId, locationsId, backendsId	updateMask, requestId, validateOnly, allowMissing	Updates the information for a single backend.
delete	delete	projectsId, locationsId, backendsId	requestId, force, etag, validateOnly	Deletes a single backend.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backendsId	string
locationsId	string
projectsId	string
allowMissing	boolean
backendId	string
etag	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
showDeleted	boolean
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets information about a backend.

SELECT
name,
annotations,
appId,
codebase,
createTime,
deleteTime,
displayName,
environment,
etag,
labels,
managedResources,
mode,
reconciling,
requestLogsDisabled,
serviceAccount,
servingLocality,
uid,
updateTime,
uri
FROM firebase.apphosting.backends
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backendsId = '{{ backendsId }}' -- required
;

list

Lists backends in a given project and location.

SELECT
name,
annotations,
appId,
codebase,
createTime,
deleteTime,
displayName,
environment,
etag,
labels,
managedResources,
mode,
reconciling,
requestLogsDisabled,
serviceAccount,
servingLocality,
uid,
updateTime,
uri
FROM firebase.apphosting.backends
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND showDeleted = '{{ showDeleted }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new backend in a given project and location.

INSERT INTO firebase.apphosting.backends (
data__annotations,
data__name,
data__displayName,
data__environment,
data__mode,
data__requestLogsDisabled,
data__serviceAccount,
data__codebase,
data__appId,
data__labels,
data__servingLocality,
projectsId,
locationsId,
validateOnly,
backendId,
requestId
)
SELECT 
'{{ annotations }}',
'{{ name }}',
'{{ displayName }}',
'{{ environment }}',
'{{ mode }}',
{{ requestLogsDisabled }},
'{{ serviceAccount }}',
'{{ codebase }}',
'{{ appId }}',
'{{ labels }}',
'{{ servingLocality }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ validateOnly }}',
'{{ backendId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: backends
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the backends resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the backends resource.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      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.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. Human-readable name. 63 character limit.
  - name: environment
    value: "{{ environment }}"
    description: |
      Optional. The environment name of the backend, used to load environment variables from environment specific configuration.
  - name: mode
    value: "{{ mode }}"
    description: |
      Optional. Deprecated: Use `environment` instead.
  - name: requestLogsDisabled
    value: {{ requestLogsDisabled }}
    description: |
      Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
  - name: serviceAccount
    value: "{{ serviceAccount }}"
    description: |
      Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
  - name: codebase
    description: |
      Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
    value:
      repository: "{{ repository }}"
      rootDirectory: "{{ rootDirectory }}"
  - name: appId
    value: "{{ appId }}"
    description: |
      Optional. 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.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Unstructured key value map that can be used to organize and categorize objects.
  - name: servingLocality
    value: "{{ servingLocality }}"
    description: |
      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).
    valid_values: ['SERVING_LOCALITY_UNSPECIFIED', 'REGIONAL_STRICT', 'GLOBAL_ACCESS']
  - name: validateOnly
    value: {{ validateOnly }}
  - name: backendId
    value: "{{ backendId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the information for a single backend.

UPDATE firebase.apphosting.backends
SET 
data__annotations = '{{ annotations }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__environment = '{{ environment }}',
data__mode = '{{ mode }}',
data__requestLogsDisabled = {{ requestLogsDisabled }},
data__serviceAccount = '{{ serviceAccount }}',
data__codebase = '{{ codebase }}',
data__appId = '{{ appId }}',
data__labels = '{{ labels }}',
data__servingLocality = '{{ servingLocality }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backendsId = '{{ backendsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single backend.

DELETE FROM firebase.apphosting.backends
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backendsId = '{{ backendsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
AND etag = '{{ etag }}'
AND validateOnly = '{{ validateOnly }}'
;