Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/truyentranh/vendor/google/apiclient-services/src/Compute/Resource/ |
<?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\ForwardingRule;
use Google\Service\Compute\ForwardingRuleAggregatedList;
use Google\Service\Compute\ForwardingRuleList;
use Google\Service\Compute\Operation;
use Google\Service\Compute\RegionSetLabelsRequest;
use Google\Service\Compute\TargetReference;
/**
* The "forwardingRules" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google\Service\Compute(...);
* $forwardingRules = $computeService->forwardingRules;
* </code>
*/
class ForwardingRules extends \Google\Service\Resource
{
/**
* Retrieves an aggregated list of forwarding rules.
* (forwardingRules.aggregatedList)
*
* @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. Most Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow API
* improvement proposal AIP-160. If you want to use AIP-160, your 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) ``` If you want to use a
* regular expression, use the `eq` (equal) or `ne` (not equal) operator against
* a single un-parenthesized expression with or without quotes or against
* multiple parenthesized expressions. Examples: `fieldname eq unquoted literal`
* `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"`
* `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is
* interpreted as a regular expression using Google RE2 library syntax. The
* literal value must match the entire field. For example, to filter for
* instances that do not end with name "instance", you would use `name ne
* .*instance`.
* @opt_param bool includeAllScopes Indicates whether every visible scope for
* each scope type (zone, region, global) should be included in the response.
* For new resource types added after this field, the flag has no effect as new
* resource types will always include every visible scope for each scope type in
* response. For resource types which predate this field, if this flag is
* omitted or false, only scopes of the scope types where the resource type is
* expected to be found will be included.
* @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 ForwardingRuleAggregatedList
*/
public function aggregatedList($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('aggregatedList', [$params], ForwardingRuleAggregatedList::class);
}
/**
* Deletes the specified ForwardingRule resource. (forwardingRules.delete)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $forwardingRule Name of the ForwardingRule resource 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, $region, $forwardingRule, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'forwardingRule' => $forwardingRule];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Returns the specified ForwardingRule resource. (forwardingRules.get)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $forwardingRule Name of the ForwardingRule resource to return.
* @param array $optParams Optional parameters.
* @return ForwardingRule
*/
public function get($project, $region, $forwardingRule, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'forwardingRule' => $forwardingRule];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ForwardingRule::class);
}
/**
* Creates a ForwardingRule resource in the specified project and region using
* the data included in the request. (forwardingRules.insert)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param ForwardingRule $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, $region, ForwardingRule $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Operation::class);
}
/**
* Retrieves a list of ForwardingRule resources available to the specified
* project and region. (forwardingRules.listForwardingRules)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. Most Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow API
* improvement proposal AIP-160. If you want to use AIP-160, your 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) ``` If you want to use a
* regular expression, use the `eq` (equal) or `ne` (not equal) operator against
* a single un-parenthesized expression with or without quotes or against
* multiple parenthesized expressions. Examples: `fieldname eq unquoted literal`
* `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"`
* `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is
* interpreted as a regular expression using Google RE2 library syntax. The
* literal value must match the entire field. For example, to filter for
* instances that do not end with name "instance", you would use `name ne
* .*instance`.
* @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 ForwardingRuleList
*/
public function listForwardingRules($project, $region, $optParams = [])
{
$params = ['project' => $project, 'region' => $region];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ForwardingRuleList::class);
}
/**
* Updates the specified forwarding rule with the data included in the request.
* This method supports PATCH semantics and uses the JSON merge patch format and
* processing rules. Currently, you can only patch the network_tier field.
* (forwardingRules.patch)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $forwardingRule Name of the ForwardingRule resource to patch.
* @param ForwardingRule $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, $region, $forwardingRule, ForwardingRule $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'forwardingRule' => $forwardingRule, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Sets the labels on the specified resource. To learn more about labels, read
* the Labeling Resources documentation. (forwardingRules.setLabels)
*
* @param string $project Project ID for this request.
* @param string $region The region for this request.
* @param string $resource Name or id of the resource for this request.
* @param RegionSetLabelsRequest $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 setLabels($project, $region, $resource, RegionSetLabelsRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setLabels', [$params], Operation::class);
}
/**
* Changes target URL for forwarding rule. The new target should be of the same
* type as the old target. (forwardingRules.setTarget)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $forwardingRule Name of the ForwardingRule resource in which
* target is to be set.
* @param TargetReference $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 setTarget($project, $region, $forwardingRule, TargetReference $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'forwardingRule' => $forwardingRule, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setTarget', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ForwardingRules::class, 'Google_Service_Compute_Resource_ForwardingRules');