domain_mappings

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

Overview

Name	domain_mappings
Type	Resource
Id	google.appengine.domain_mappings

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	Relative name of the domain serving the application. Example: example.com.
name	string	Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
resourceRecords	array	The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
sslSettings	object	SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. (id: SslSettings)

list

Successful response

Name	Datatype	Description
id	string	Relative name of the domain serving the application. Example: example.com.
name	string	Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
resourceRecords	array	The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
sslSettings	object	SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. (id: SslSettings)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, applicationsId, domainMappingsId		Gets the specified domain mapping.
list	select	appsId	pageSize, pageToken	Lists the domain mappings on an application.
create	insert	projectsId, locationsId, applicationsId	overrideStrategy	Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.
patch	update	appsId, domainMappingsId	updateMask	Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
delete	delete	appsId, domainMappingsId		Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

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
applicationsId	string
appsId	string
domainMappingsId	string
locationsId	string
projectsId	string
overrideStrategy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the specified domain mapping.

SELECT
id,
name,
resourceRecords,
sslSettings
FROM google.appengine.domain_mappings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND applicationsId = '{{ applicationsId }}' -- required
AND domainMappingsId = '{{ domainMappingsId }}' -- required;

list

Lists the domain mappings on an application.

SELECT
id,
name,
resourceRecords,
sslSettings
FROM google.appengine.domain_mappings
WHERE appsId = '{{ appsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

INSERT INTO google.appengine.domain_mappings (
data__name,
data__id,
data__sslSettings,
data__resourceRecords,
projectsId,
locationsId,
applicationsId,
overrideStrategy
)
SELECT 
'{{ name }}',
'{{ id }}',
'{{ sslSettings }}',
'{{ resourceRecords }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ applicationsId }}',
'{{ overrideStrategy }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: domain_mappings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the domain_mappings resource.
    - name: locationsId
      value: string
      description: Required parameter for the domain_mappings resource.
    - name: applicationsId
      value: string
      description: Required parameter for the domain_mappings resource.
    - name: name
      value: string
      description: >
        Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
        
    - name: id
      value: string
      description: >
        Relative name of the domain serving the application. Example: example.com.
        
    - name: sslSettings
      value: object
      description: >
        SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
        
    - name: resourceRecords
      value: array
      description: >
        The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
        
    - name: overrideStrategy
      value: string

UPDATE examples

patch

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

UPDATE google.appengine.domain_mappings
SET 
data__name = '{{ name }}',
data__id = '{{ id }}',
data__sslSettings = '{{ sslSettings }}',
data__resourceRecords = '{{ resourceRecords }}'
WHERE 
appsId = '{{ appsId }}' --required
AND domainMappingsId = '{{ domainMappingsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

DELETE FROM google.appengine.domain_mappings
WHERE appsId = '{{ appsId }}' --required
AND domainMappingsId = '{{ domainMappingsId }}' --required;