📄 Source: ResourceRecordSets.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\Dns\Resource;
use Google\Service\Dns\ResourceRecordSet;
use Google\Service\Dns\ResourceRecordSetsDeleteResponse;
use Google\Service\Dns\ResourceRecordSetsListResponse;
/**
* The "resourceRecordSets" collection of methods.
* Typical usage is:
* <code>
* $dnsService = new Google\Service\Dns(...);
* $resourceRecordSets = $dnsService->resourceRecordSets;
* </code>
*/
class ResourceRecordSets extends \Google\Service\Resource
{
/**
* Creates a new ResourceRecordSet. (resourceRecordSets.create)
*
* @param string $project Identifies the project addressed by this request.
* @param string $managedZone Identifies the managed zone addressed by this
* request. Can be the managed zone name or ID.
* @param ResourceRecordSet $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string clientOperationId For mutating operation requests only. An
* optional identifier specified by the client. Must be unique for operation
* resources in the Operations collection.
* @return ResourceRecordSet
* @throws \Google\Service\Exception
*/
public function create($project, $managedZone, ResourceRecordSet $postBody, $optParams = [])
{
$params = ['project' => $project, 'managedZone' => $managedZone, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], ResourceRecordSet::class);
}
/**
* Deletes a previously created ResourceRecordSet. (resourceRecordSets.delete)
*
* @param string $project Identifies the project addressed by this request.
* @param string $managedZone Identifies the managed zone addressed by this
* request. Can be the managed zone name or ID.
* @param string $name Fully qualified domain name.
* @param string $type RRSet type.
* @param array $optParams Optional parameters.
*
* @opt_param string clientOperationId For mutating operation requests only. An
* optional identifier specified by the client. Must be unique for operation
* resources in the Operations collection.
* @return ResourceRecordSetsDeleteResponse
* @throws \Google\Service\Exception
*/
public function delete($project, $managedZone, $name, $type, $optParams = [])
{
$params = ['project' => $project, 'managedZone' => $managedZone, 'name' => $name, 'type' => $type];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], ResourceRecordSetsDeleteResponse::class);
}
/**
* Fetches the representation of an existing ResourceRecordSet.
* (resourceRecordSets.get)
*
* @param string $project Identifies the project addressed by this request.
* @param string $managedZone Identifies the managed zone addressed by this
* request. Can be the managed zone name or ID.
* @param string $name Fully qualified domain name.
* @param string $type RRSet type.
* @param array $optParams Optional parameters.
*
* @opt_param string clientOperationId For mutating operation requests only. An
* optional identifier specified by the client. Must be unique for operation
* resources in the Operations collection.
* @return ResourceRecordSet
* @throws \Google\Service\Exception
*/
public function get($project, $managedZone, $name, $type, $optParams = [])
{
$params = ['project' => $project, 'managedZone' => $managedZone, 'name' => $name, 'type' => $type];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ResourceRecordSet::class);
}
/**
* Enumerates ResourceRecordSets that you have created but not yet deleted.
* (resourceRecordSets.listResourceRecordSets)
*
* @param string $project Identifies the project addressed by this request.
* @param string $managedZone Identifies the managed zone addressed by this
* request. Can be the managed zone name or ID.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Specify a filter expression to view records that
* exactly match the specified domain. Both the `name` and `type` parameters are
* not supported and must be omitted when you use `filter`. Your `filter`
* expression must conform to AIP-160 and you must specify a domain in the
* `name` field. Optionally, you can include the `type` field to filter records
* by type. You can also include the `has_suffix` function to view records that
* match by domain suffix. Examples: * `name`="example.com." *
* `name`="example.com." AND type="A" * `name`=`has_suffix`("example.com.") *
* `name`=`has_suffix`("example.com.") AND type="A"
* @opt_param int maxResults Optional. Maximum number of results to be returned.
* If unspecified, the server decides how many results to return.
* @opt_param string name Specify a fully qualified domain name to view only
* those records. The `name` parameter is not supported and must be omitted when
* you use `filter`.
* @opt_param string pageToken Optional. A tag returned by a previous list
* request that was truncated. Use this parameter to continue a previous list
* request.
* @opt_param string type Specify a record type to view only those records. You
* must also specify the `name` parameter. The `type` parameter is not supported
* and must be omitted when you use `filter`.
* @return ResourceRecordSetsListResponse
* @throws \Google\Service\Exception
*/
public function listResourceRecordSets($project, $managedZone, $optParams = [])
{
$params = ['project' => $project, 'managedZone' => $managedZone];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ResourceRecordSetsListResponse::class);
}
/**
* Applies a partial update to an existing ResourceRecordSet.
* (resourceRecordSets.patch)
*
* @param string $project Identifies the project addressed by this request.
* @param string $managedZone Identifies the managed zone addressed by this
* request. Can be the managed zone name or ID.
* @param string $name Fully qualified domain name.
* @param string $type RRSet type.
* @param ResourceRecordSet $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string clientOperationId For mutating operation requests only. An
* optional identifier specified by the client. Must be unique for operation
* resources in the Operations collection.
* @return ResourceRecordSet
* @throws \Google\Service\Exception
*/
public function patch($project, $managedZone, $name, $type, ResourceRecordSet $postBody, $optParams = [])
{
$params = ['project' => $project, 'managedZone' => $managedZone, 'name' => $name, 'type' => $type, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], ResourceRecordSet::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ResourceRecordSets::class, 'Google_Service_Dns_Resource_ResourceRecordSets');
← Back