Documentation

Google_Service_Appengine_Resource_AppsDomainMappings extends Google_Service_Resource
in package

The "domainMappings" collection of methods.

Typical usage is: $appengineService = new Google_Service_Appengine(...); $domainMappings = $appengineService->domainMappings;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Appengine_Operation
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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Appengine_Operation
Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
get()  : Google_Service_Appengine_DomainMapping
Gets the specified domain mapping. (domainMappings.get)
listAppsDomainMappings()  : Google_Service_Appengine_ListDomainMappingsResponse
Lists the domain mappings on an application.
patch()  : Google_Service_Appengine_Operation
Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

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.

public create(string $appsId, Google_Service_Appengine_DomainMapping $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Operation

(domainMappings.create)

Parameters
$appsId : string

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

$postBody : Google_Service_Appengine_DomainMapping
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string overrideStrategy Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.

Return values
Google_Service_Appengine_Operation

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

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

public delete(string $appsId, string $domainMappingsId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Operation

(domainMappings.delete)

Parameters
$appsId : string

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

$domainMappingsId : string

Part of name. See documentation of appsId.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_Operation

get()

Gets the specified domain mapping. (domainMappings.get)

public get(string $appsId, string $domainMappingsId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_DomainMapping
Parameters
$appsId : string

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

$domainMappingsId : string

Part of name. See documentation of appsId.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_DomainMapping

listAppsDomainMappings()

Lists the domain mappings on an application.

public listAppsDomainMappings(string $appsId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_ListDomainMappingsResponse

(domainMappings.listAppsDomainMappings)

Parameters
$appsId : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Continuation token for fetching the next page of results.

opt_param

int pageSize Maximum results to return per page.

Return values
Google_Service_Appengine_ListDomainMappingsResponse

patch()

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

public patch(string $appsId, string $domainMappingsId, Google_Service_Appengine_DomainMapping $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Operation

A user must be authorized to administer the associated domain in order to update a DomainMapping resource. (domainMappings.patch)

Parameters
$appsId : string

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

$domainMappingsId : string

Part of name. See documentation of appsId.

$postBody : Google_Service_Appengine_DomainMapping
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Standard field mask for the set of fields to be updated.

Return values
Google_Service_Appengine_Operation

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results