Documentation

Google_Service_Dns_Resource_Policies extends Google_Service_Resource
in package

The "policies" collection of methods.

Typical usage is: $dnsService = new Google_Service_Dns(...); $policies = $dnsService->policies;

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_Dns_Policy
Create a new Policy (policies.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Delete a previously created Policy. Will fail if the policy is still being referenced by a network. (policies.delete)
get()  : Google_Service_Dns_Policy
Fetch the representation of an existing Policy. (policies.get)
listPolicies()  : Google_Service_Dns_PoliciesListResponse
Enumerate all Policies associated with a project. (policies.listPolicies)
patch()  : Google_Service_Dns_PoliciesPatchResponse
Apply a partial update to an existing Policy. (policies.patch)
update()  : Google_Service_Dns_PoliciesUpdateResponse
Update an existing Policy. (policies.update)
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()

Create a new Policy (policies.create)

public create(string $project, Google_Service_Dns_Policy $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dns_Policy
Parameters
$project : string

Identifies the project addressed by this request.

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

Optional parameters.

Tags
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 values
Google_Service_Dns_Policy

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()

Delete a previously created Policy. Will fail if the policy is still being referenced by a network. (policies.delete)

public delete(string $project, string $policy[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$project : string

Identifies the project addressed by this request.

$policy : string

User given friendly name of the policy addressed by this request.

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

Optional parameters.

Tags
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 values
mixed

get()

Fetch the representation of an existing Policy. (policies.get)

public get(string $project, string $policy[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dns_Policy
Parameters
$project : string

Identifies the project addressed by this request.

$policy : string

User given friendly name of the policy addressed by this request.

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

Optional parameters.

Tags
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 values
Google_Service_Dns_Policy

listPolicies()

Enumerate all Policies associated with a project. (policies.listPolicies)

public listPolicies(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dns_PoliciesListResponse
Parameters
$project : string

Identifies the project addressed by this request.

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

Optional parameters.

Tags
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

int maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

Return values
Google_Service_Dns_PoliciesListResponse

patch()

Apply a partial update to an existing Policy. (policies.patch)

public patch(string $project, string $policy, Google_Service_Dns_Policy $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dns_PoliciesPatchResponse
Parameters
$project : string

Identifies the project addressed by this request.

$policy : string

User given friendly name of the policy addressed by this request.

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

Optional parameters.

Tags
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 values
Google_Service_Dns_PoliciesPatchResponse

update()

Update an existing Policy. (policies.update)

public update(string $project, string $policy, Google_Service_Dns_Policy $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dns_PoliciesUpdateResponse
Parameters
$project : string

Identifies the project addressed by this request.

$policy : string

User given friendly name of the policy addressed by this request.

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

Optional parameters.

Tags
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 values
Google_Service_Dns_PoliciesUpdateResponse

convertToArrayAndStripNulls()

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

Search results