Current File : /home/graphicd/www/vebto/vendor/google/apiclient-services/src/Compute/Resource/SecurityPolicies.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\Compute\Resource;
use Google\Service\Compute\Operation;
use Google\Service\Compute\SecurityPoliciesListPreconfiguredExpressionSetsResponse;
use Google\Service\Compute\SecurityPolicy;
use Google\Service\Compute\SecurityPolicyList;
use Google\Service\Compute\SecurityPolicyRule;
/**
* The "securityPolicies" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google\Service\Compute(...);
* $securityPolicies = $computeService->securityPolicies;
* </code>
*/
class SecurityPolicies extends \Google\Service\Resource
{
/**
* Inserts a rule into a security policy. (securityPolicies.addRule)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to update.
* @param SecurityPolicyRule $postBody
* @param array $optParams Optional parameters.
* @return Operation
*/
public function addRule($project, $securityPolicy, SecurityPolicyRule $postBody, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addRule', [$params], Operation::class);
}
/**
* Deletes the specified policy. (securityPolicies.delete)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to delete.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId An optional request ID to identify requests.
* Specify a unique request ID so that if you must retry your request, the
* server will know to ignore the request if it has already been completed. For
* example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments. The request ID must be a
* valid UUID with the exception that zero UUID is not supported (
* 00000000-0000-0000-0000-000000000000).
* @return Operation
*/
public function delete($project, $securityPolicy, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* List all of the ordered rules present in a single specified policy.
* (securityPolicies.get)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to get.
* @param array $optParams Optional parameters.
* @return SecurityPolicy
*/
public function get($project, $securityPolicy, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], SecurityPolicy::class);
}
/**
* Gets a rule at the specified priority. (securityPolicies.getRule)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to which the
* queried rule belongs.
* @param array $optParams Optional parameters.
*
* @opt_param int priority The priority of the rule to get from the security
* policy.
* @return SecurityPolicyRule
*/
public function getRule($project, $securityPolicy, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy];
$params = array_merge($params, $optParams);
return $this->call('getRule', [$params], SecurityPolicyRule::class);
}
/**
* Creates a new policy in the specified project using the data included in the
* request. (securityPolicies.insert)
*
* @param string $project Project ID for this request.
* @param SecurityPolicy $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId An optional request ID to identify requests.
* Specify a unique request ID so that if you must retry your request, the
* server will know to ignore the request if it has already been completed. For
* example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments. The request ID must be a
* valid UUID with the exception that zero UUID is not supported (
* 00000000-0000-0000-0000-000000000000).
* @return Operation
*/
public function insert($project, SecurityPolicy $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Operation::class);
}
/**
* List all the policies that have been configured for the specified project.
* (securityPolicies.listSecurityPolicies)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. The expression must specify the field name, an operator, and
* the value that you want to use for filtering. The value must be a string, a
* number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`,
* `>=` or `:`. For example, if you are filtering Compute Engine instances, you
* can exclude instances named `example-instance` by specifying `name !=
* example-instance`. The `:` operator can be used with string fields to match
* substrings. For non-string fields it is equivalent to the `=` operator. The
* `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
* You can also filter nested fields. For example, you could specify
* `scheduling.automaticRestart = false` to include instances only if they are
* not scheduled for automatic restarts. You can use filtering on nested fields
* to filter based on resource labels. To filter on multiple expressions,
* provide each separate expression within parentheses. For example: ```
* (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
* default, each expression is an `AND` expression. However, you can include
* `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
* Skylake") OR (cpuPlatform = "Intel Broadwell") AND
* (scheduling.automaticRestart = true) ```
* @opt_param string maxResults The maximum number of results per page that
* should be returned. If the number of available results is larger than
* `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
* get the next page of results in subsequent list requests. Acceptable values
* are `0` to `500`, inclusive. (Default: `500`)
* @opt_param string orderBy Sorts list results by a certain order. By default,
* results are returned in alphanumerical order based on the resource name. You
* can also sort results in descending order based on the creation timestamp
* using `orderBy="creationTimestamp desc"`. This sorts results based on the
* `creationTimestamp` field in reverse chronological order (newest result
* first). Use this to sort resources like operations so that the newest
* operation is returned first. Currently, only sorting by `name` or
* `creationTimestamp desc` is supported.
* @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
* the `nextPageToken` returned by a previous list request to get the next page
* of results.
* @opt_param bool returnPartialSuccess Opt-in for partial success behavior
* which provides partial results in case of failure. The default value is
* false.
* @return SecurityPolicyList
*/
public function listSecurityPolicies($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], SecurityPolicyList::class);
}
/**
* Gets the current list of preconfigured Web Application Firewall (WAF)
* expressions. (securityPolicies.listPreconfiguredExpressionSets)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. The expression must specify the field name, an operator, and
* the value that you want to use for filtering. The value must be a string, a
* number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`,
* `>=` or `:`. For example, if you are filtering Compute Engine instances, you
* can exclude instances named `example-instance` by specifying `name !=
* example-instance`. The `:` operator can be used with string fields to match
* substrings. For non-string fields it is equivalent to the `=` operator. The
* `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
* You can also filter nested fields. For example, you could specify
* `scheduling.automaticRestart = false` to include instances only if they are
* not scheduled for automatic restarts. You can use filtering on nested fields
* to filter based on resource labels. To filter on multiple expressions,
* provide each separate expression within parentheses. For example: ```
* (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
* default, each expression is an `AND` expression. However, you can include
* `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
* Skylake") OR (cpuPlatform = "Intel Broadwell") AND
* (scheduling.automaticRestart = true) ```
* @opt_param string maxResults The maximum number of results per page that
* should be returned. If the number of available results is larger than
* `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
* get the next page of results in subsequent list requests. Acceptable values
* are `0` to `500`, inclusive. (Default: `500`)
* @opt_param string orderBy Sorts list results by a certain order. By default,
* results are returned in alphanumerical order based on the resource name. You
* can also sort results in descending order based on the creation timestamp
* using `orderBy="creationTimestamp desc"`. This sorts results based on the
* `creationTimestamp` field in reverse chronological order (newest result
* first). Use this to sort resources like operations so that the newest
* operation is returned first. Currently, only sorting by `name` or
* `creationTimestamp desc` is supported.
* @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
* the `nextPageToken` returned by a previous list request to get the next page
* of results.
* @opt_param bool returnPartialSuccess Opt-in for partial success behavior
* which provides partial results in case of failure. The default value is
* false.
* @return SecurityPoliciesListPreconfiguredExpressionSetsResponse
*/
public function listPreconfiguredExpressionSets($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('listPreconfiguredExpressionSets', [$params], SecurityPoliciesListPreconfiguredExpressionSetsResponse::class);
}
/**
* Patches the specified policy with the data included in the request. This
* cannot be used to be update the rules in the policy. Please use the per rule
* methods like addRule, patchRule, and removeRule instead.
* (securityPolicies.patch)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to update.
* @param SecurityPolicy $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId An optional request ID to identify requests.
* Specify a unique request ID so that if you must retry your request, the
* server will know to ignore the request if it has already been completed. For
* example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments. The request ID must be a
* valid UUID with the exception that zero UUID is not supported (
* 00000000-0000-0000-0000-000000000000).
* @return Operation
*/
public function patch($project, $securityPolicy, SecurityPolicy $postBody, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Patches a rule at the specified priority. (securityPolicies.patchRule)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to update.
* @param SecurityPolicyRule $postBody
* @param array $optParams Optional parameters.
*
* @opt_param int priority The priority of the rule to patch.
* @return Operation
*/
public function patchRule($project, $securityPolicy, SecurityPolicyRule $postBody, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patchRule', [$params], Operation::class);
}
/**
* Deletes a rule at the specified priority. (securityPolicies.removeRule)
*
* @param string $project Project ID for this request.
* @param string $securityPolicy Name of the security policy to update.
* @param array $optParams Optional parameters.
*
* @opt_param int priority The priority of the rule to remove from the security
* policy.
* @return Operation
*/
public function removeRule($project, $securityPolicy, $optParams = [])
{
$params = ['project' => $project, 'securityPolicy' => $securityPolicy];
$params = array_merge($params, $optParams);
return $this->call('removeRule', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SecurityPolicies::class, 'Google_Service_Compute_Resource_SecurityPolicies');
Mini Shell