1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Appengine
  7. \
  8. Resource
  9. \
  10. AppsDomainMappings

AppsDomainMappings

class AppsDomainMappings extends Resource (View source)

The "domainMappings" collection of methods.

Typical usage is:

 $appengineService = new Google\Service\Appengine(...);
 $domainMappings = $appengineService->apps_domainMappings;

Methods

Operation
create(string $appsId, DomainMapping $postBody, array $optParams = [])

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.

Operation
delete(string $appsId, string $domainMappingsId, array $optParams = [])

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

DomainMapping
get(string $appsId, string $domainMappingsId, array $optParams = [])

Gets the specified domain mapping. (domainMappings.get)

ListDomainMappingsResponse
listAppsDomainMappings(string $appsId, array $optParams = [])

Lists the domain mappings on an application.

Operation
patch(string $appsId, string $domainMappingsId, DomainMapping $postBody, array $optParams = [])

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource.

Details

at line 51
Operation create(string $appsId, DomainMapping $postBody, array $optParams = [])

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.

(domainMappings.create)

Parameters

string $appsId

Part of parent. Name of the parent Application resource. Example: apps/myapp.
DomainMapping $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 70
Operation delete(string $appsId, string $domainMappingsId, array $optParams = [])

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

(domainMappings.delete)

Parameters

string $appsId

Part of name. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.
string $domainMappingsId

Part of name. See documentation of appsId.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 87
DomainMapping get(string $appsId, string $domainMappingsId, array $optParams = [])

Gets the specified domain mapping. (domainMappings.get)

Parameters

string $appsId

Part of name. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.
string $domainMappingsId

Part of name. See documentation of appsId.
array $optParams

Optional parameters.

Return Value

DomainMapping

Exceptions

Exception

at line 107
ListDomainMappingsResponse listAppsDomainMappings(string $appsId, array $optParams = [])

Lists the domain mappings on an application.

(domainMappings.listAppsDomainMappings)

Parameters

string $appsId

Part of parent. Name of the parent Application resource. Example: apps/myapp.
array $optParams

Optional parameters.

Return Value

ListDomainMappingsResponse

Exceptions

Exception

at line 131
Operation patch(string $appsId, string $domainMappingsId, DomainMapping $postBody, array $optParams = [])

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. (domainMappings.patch)

Parameters

string $appsId

Part of name. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.
string $domainMappingsId

Part of name. See documentation of appsId.
DomainMapping $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception