📄 Source: ProjectsLocationsApplicationsDomainMappings.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Appengine\Resource;
use Google\Service\Appengine\DomainMapping;
use Google\Service\Appengine\ListDomainMappingsResponse;
use Google\Service\Appengine\Operation;
/**
* The "domainMappings" collection of methods.
* Typical usage is:
* <code>
* $appengineService = new Google\Service\Appengine(...);
* $domainMappings = $appengineService->projects_locations_applications_domainMappings;
* </code>
*/
class ProjectsLocationsApplicationsDomainMappings extends \Google\Service\Resource
{
/**
* 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)
*
* @param string $projectsId Part of `parent`. Required. Name of the parent
* Application resource. Example: apps/myapp.
* @param string $locationsId Part of `parent`. See documentation of
* `projectsId`.
* @param string $applicationsId Part of `parent`. See documentation of
* `projectsId`.
* @param DomainMapping $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string overrideStrategy Whether the domain creation should
* override any existing mappings for this domain. By default, overrides are
* rejected.
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($projectsId, $locationsId, $applicationsId, DomainMapping $postBody, $optParams = [])
{
$params = ['projectsId' => $projectsId, 'locationsId' => $locationsId, 'applicationsId' => $applicationsId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes the specified domain mapping. A user must be authorized to administer
* the associated domain in order to delete a DomainMapping resource.
* (domainMappings.delete)
*
* @param string $projectsId Part of `name`. Required. Name of the resource to
* delete. Example: apps/myapp/domainMappings/example.com.
* @param string $locationsId Part of `name`. See documentation of `projectsId`.
* @param string $applicationsId Part of `name`. See documentation of
* `projectsId`.
* @param string $domainMappingsId Part of `name`. See documentation of
* `projectsId`.
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function delete($projectsId, $locationsId, $applicationsId, $domainMappingsId, $optParams = [])
{
$params = ['projectsId' => $projectsId, 'locationsId' => $locationsId, 'applicationsId' => $applicationsId, 'domainMappingsId' => $domainMappingsId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Gets the specified domain mapping. (domainMappings.get)
*
* @param string $projectsId Part of `name`. Required. Name of the resource
* requested. Example: apps/myapp/domainMappings/example.com.
* @param string $locationsId Part of `name`. See documentation of `projectsId`.
* @param string $applicationsId Part of `name`. See documentation of
* `projectsId`.
* @param string $domainMappingsId Part of `name`. See documentation of
* `projectsId`.
* @param array $optParams Optional parameters.
* @return DomainMapping
* @throws \Google\Service\Exception
*/
public function get($projectsId, $locationsId, $applicationsId, $domainMappingsId, $optParams = [])
{
$params = ['projectsId' => $projectsId, 'locationsId' => $locationsId, 'applicationsId' => $applicationsId, 'domainMappingsId' => $domainMappingsId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], DomainMapping::class);
}
/**
* Lists the domain mappings on an application.
* (domainMappings.listProjectsLocationsApplicationsDomainMappings)
*
* @param string $projectsId Part of `parent`. Required. Name of the parent
* Application resource. Example: apps/myapp.
* @param string $locationsId Part of `parent`. See documentation of
* `projectsId`.
* @param string $applicationsId Part of `parent`. See documentation of
* `projectsId`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Maximum results to return per page.
* @opt_param string pageToken Continuation token for fetching the next page of
* results.
* @return ListDomainMappingsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsApplicationsDomainMappings($projectsId, $locationsId, $applicationsId, $optParams = [])
{
$params = ['projectsId' => $projectsId, 'locationsId' => $locationsId, 'applicationsId' => $applicationsId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListDomainMappingsResponse::class);
}
/**
* 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)
*
* @param string $projectsId Part of `name`. Required. Name of the resource to
* update. Example: apps/myapp/domainMappings/example.com.
* @param string $locationsId Part of `name`. See documentation of `projectsId`.
* @param string $applicationsId Part of `name`. See documentation of
* `projectsId`.
* @param string $domainMappingsId Part of `name`. See documentation of
* `projectsId`.
* @param DomainMapping $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Required. Standard field mask for the set of
* fields to be updated.
* @return Operation
* @throws \Google\Service\Exception
*/
public function patch($projectsId, $locationsId, $applicationsId, $domainMappingsId, DomainMapping $postBody, $optParams = [])
{
$params = ['projectsId' => $projectsId, 'locationsId' => $locationsId, 'applicationsId' => $applicationsId, 'domainMappingsId' => $domainMappingsId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsApplicationsDomainMappings::class, 'Google_Service_Appengine_Resource_ProjectsLocationsApplicationsDomainMappings');
← Back