domains

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

Overview

Name	domains
Type	Resource
Id	firebase.apphosting.domains

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the domain, e.g. /projects/p/locations/l/backends/b/domains/foo.com
annotations	object	Optional. Annotations as key value pairs.
createTime	string (google-datetime)	Output only. Time at which the domain was created.
customDomainStatus	object	Output only. Represents the state and configuration of a CUSTOM type domain. It is only present on Domains of that type. (id: CustomDomainStatus)
deleteTime	string (google-datetime)	Output only. Time at which the domain was deleted.
disabled	boolean	Optional. Whether the domain is disabled. Defaults to false.
displayName	string	Optional. Mutable human-readable name for the domain. 63 character limit. e.g. prod domain.
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. Labels as key value pairs.
reconciling	boolean	Output only. A field that, if true, indicates that the build has an ongoing LRO.
serve	object	Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. (id: ServingBehavior)
type	string	Output only. The type of the domain.
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. Time at which the domain was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the domain, e.g. /projects/p/locations/l/backends/b/domains/foo.com
annotations	object	Optional. Annotations as key value pairs.
createTime	string (google-datetime)	Output only. Time at which the domain was created.
customDomainStatus	object	Output only. Represents the state and configuration of a CUSTOM type domain. It is only present on Domains of that type. (id: CustomDomainStatus)
deleteTime	string (google-datetime)	Output only. Time at which the domain was deleted.
disabled	boolean	Optional. Whether the domain is disabled. Defaults to false.
displayName	string	Optional. Mutable human-readable name for the domain. 63 character limit. e.g. prod domain.
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. Labels as key value pairs.
reconciling	boolean	Output only. A field that, if true, indicates that the build has an ongoing LRO.
serve	object	Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. (id: ServingBehavior)
type	string	Output only. The type of the domain.
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. Time at which the domain was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backendsId, domainsId		Gets information about a domain.
list	select	projectsId, locationsId, backendsId	pageSize, pageToken, filter, orderBy, showDeleted	Lists domains of a backend.
create	insert	projectsId, locationsId, backendsId	domainId, requestId, validateOnly	Links a new domain to a backend.
patch	update	projectsId, locationsId, backendsId, domainsId	updateMask, requestId, validateOnly, allowMissing	Updates the information for a single domain.
delete	delete	projectsId, locationsId, backendsId, domainsId	requestId, etag, validateOnly	Deletes a single domain.

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
domainsId	string
locationsId	string
projectsId	string
allowMissing	boolean
domainId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
showDeleted	boolean
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets information about a domain.

SELECT
name,
annotations,
createTime,
customDomainStatus,
deleteTime,
disabled,
displayName,
etag,
labels,
reconciling,
serve,
type,
uid,
updateTime
FROM firebase.apphosting.domains
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backendsId = '{{ backendsId }}' -- required
AND domainsId = '{{ domainsId }}' -- required;

list

Lists domains of a backend.

SELECT
name,
annotations,
createTime,
customDomainStatus,
deleteTime,
disabled,
displayName,
etag,
labels,
reconciling,
serve,
type,
uid,
updateTime
FROM firebase.apphosting.domains
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backendsId = '{{ backendsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND showDeleted = '{{ showDeleted }}';

INSERT examples

create

Links a new domain to a backend.

INSERT INTO firebase.apphosting.domains (
data__name,
data__displayName,
data__disabled,
data__serve,
data__labels,
data__annotations,
projectsId,
locationsId,
backendsId,
domainId,
requestId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ displayName }}',
{{ disabled }},
'{{ serve }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ backendsId }}',
'{{ domainId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: domains
  props:
    - name: projectsId
      value: string
      description: Required parameter for the domains resource.
    - name: locationsId
      value: string
      description: Required parameter for the domains resource.
    - name: backendsId
      value: string
      description: Required parameter for the domains resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`
        
    - name: displayName
      value: string
      description: >
        Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`.
        
    - name: disabled
      value: boolean
      description: >
        Optional. Whether the domain is disabled. Defaults to false.
        
    - name: serve
      value: object
      description: >
        Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content.
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs.
        
    - name: annotations
      value: object
      description: >
        Optional. Annotations as key value pairs.
        
    - name: domainId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Updates the information for a single domain.

UPDATE firebase.apphosting.domains
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__disabled = {{ disabled }},
data__serve = '{{ serve }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backendsId = '{{ backendsId }}' --required
AND domainsId = '{{ domainsId }}' --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 domain.

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