📄 Source: Routers.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\NatIpInfoResponse;
use Google\Service\Compute\Operation;
use Google\Service\Compute\RoutePolicy;
use Google\Service\Compute\Router;
use Google\Service\Compute\RouterAggregatedList;
use Google\Service\Compute\RouterList;
use Google\Service\Compute\RouterStatusResponse;
use Google\Service\Compute\RoutersGetRoutePolicyResponse;
use Google\Service\Compute\RoutersListBgpRoutes;
use Google\Service\Compute\RoutersListRoutePolicies;
use Google\Service\Compute\RoutersPreviewResponse;
use Google\Service\Compute\VmEndpointNatMappingsList;
/**
* The "routers" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google\Service\Compute(...);
* $routers = $computeService->routers;
* </code>
*/
class Routers extends \Google\Service\Resource
{
/**
* Retrieves an aggregated list of routers.
*
* To prevent failure, Google recommends that you set the `returnPartialSuccess`
* parameter to `true`. (routers.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. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `:*` 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 onresource 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 GoogleRE2
* 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`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @opt_param string serviceProjectNumber The Shared VPC service project id or
* service project number for which aggregated list request is invoked for
* subnetworks list-usable api.
* @return RouterAggregatedList
* @throws \Google\Service\Exception
*/
public function aggregatedList($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('aggregatedList', [$params], RouterAggregatedList::class);
}
/**
* Deletes the specified Router resource. (routers.delete)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router 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
* @throws \Google\Service\Exception
*/
public function delete($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Deletes Route Policy (routers.deleteRoutePolicy)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource where Route Policy is
* defined.
* @param array $optParams Optional parameters.
*
* @opt_param string policy The Policy name for this request. Name must conform
* to RFC1035
* @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
* @throws \Google\Service\Exception
*/
public function deleteRoutePolicy($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('deleteRoutePolicy', [$params], Operation::class);
}
/**
* Returns the specified Router resource. (routers.get)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to return.
* @param array $optParams Optional parameters.
* @return Router
* @throws \Google\Service\Exception
*/
public function get($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Router::class);
}
/**
* Retrieves runtime NAT IP information. (routers.getNatIpInfo)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to query for Nat IP
* information. The name should conform to RFC1035.
* @param array $optParams Optional parameters.
*
* @opt_param string natName Name of the nat service to filter the NAT IP
* information. If it is omitted, all nats for this router will be returned.
* Name should conform to RFC1035.
* @return NatIpInfoResponse
* @throws \Google\Service\Exception
*/
public function getNatIpInfo($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('getNatIpInfo', [$params], NatIpInfoResponse::class);
}
/**
* Retrieves runtime Nat mapping information of VM endpoints.
* (routers.getNatMappingInfo)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to query for Nat Mapping
* information of VM endpoints.
* @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. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `:*` 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 onresource 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 GoogleRE2
* 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`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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 natName Name of the nat service to filter the Nat Mapping
* information. If it is omitted, all nats for this router will be returned.
* Name should conform to RFC1035.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return VmEndpointNatMappingsList
* @throws \Google\Service\Exception
*/
public function getNatMappingInfo($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('getNatMappingInfo', [$params], VmEndpointNatMappingsList::class);
}
/**
* Returns specified Route Policy (routers.getRoutePolicy)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to query for the route
* policy. The name should conform to RFC1035.
* @param array $optParams Optional parameters.
*
* @opt_param string policy The Policy name for this request. Name must conform
* to RFC1035
* @return RoutersGetRoutePolicyResponse
* @throws \Google\Service\Exception
*/
public function getRoutePolicy($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('getRoutePolicy', [$params], RoutersGetRoutePolicyResponse::class);
}
/**
* Retrieves runtime information of the specified router.
* (routers.getRouterStatus)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to query.
* @param array $optParams Optional parameters.
* @return RouterStatusResponse
* @throws \Google\Service\Exception
*/
public function getRouterStatus($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('getRouterStatus', [$params], RouterStatusResponse::class);
}
/**
* Creates a Router resource in the specified project and region using the data
* included in the request. (routers.insert)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param Router $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
* @throws \Google\Service\Exception
*/
public function insert($project, $region, Router $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 Router resources available to the specified project.
* (routers.listRouters)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region 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. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `:*` 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 onresource 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 GoogleRE2
* 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`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return RouterList
* @throws \Google\Service\Exception
*/
public function listRouters($project, $region, $optParams = [])
{
$params = ['project' => $project, 'region' => $region];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], RouterList::class);
}
/**
* Retrieves a list of router bgp routes available to the specified project.
* (routers.listBgpRoutes)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name or id of the resource for this request. Name
* should conform to RFC1035.
* @param array $optParams Optional parameters.
*
* @opt_param string addressFamily (Required) limit results to this address
* family (either IPv4 or IPv6)
* @opt_param string destinationPrefix Limit results to destinations that are
* subnets of this CIDR range
* @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. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `:*` 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 onresource 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 GoogleRE2
* 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`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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 string peer (Required) limit results to the BGP peer with the
* given name. Name should conform to RFC1035.
* @opt_param bool policyApplied When true, the method returns post-policy
* routes. Otherwise, it returns pre-policy routes.
* @opt_param bool returnPartialSuccess Opt-in for partial success behavior
* which provides partial results in case of failure. The default value is
* false.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @opt_param string routeType (Required) limit results to this type of route
* (either LEARNED or ADVERTISED)
* @return RoutersListBgpRoutes
* @throws \Google\Service\Exception
*/
public function listBgpRoutes($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('listBgpRoutes', [$params], RoutersListBgpRoutes::class);
}
/**
* Retrieves a list of router route policy subresources available to the
* specified project. (routers.listRoutePolicies)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name or id of the resource for this request. Name
* should conform to RFC1035.
* @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. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `:*` 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 onresource 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 GoogleRE2
* 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`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return RoutersListRoutePolicies
* @throws \Google\Service\Exception
*/
public function listRoutePolicies($project, $region, $router, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router];
$params = array_merge($params, $optParams);
return $this->call('listRoutePolicies', [$params], RoutersListRoutePolicies::class);
}
/**
* Patches the specified Router resource with the data included in the request.
* This method supportsPATCH semantics and usesJSON merge patch format and
* processing rules. (routers.patch)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to patch.
* @param Router $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
* @throws \Google\Service\Exception
*/
public function patch($project, $region, $router, Router $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Patches Route Policy (routers.patchRoutePolicy)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource where Route Policy is
* defined.
* @param RoutePolicy $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
* @throws \Google\Service\Exception
*/
public function patchRoutePolicy($project, $region, $router, RoutePolicy $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patchRoutePolicy', [$params], Operation::class);
}
/**
* Preview fields auto-generated during router create andupdate operations.
* Calling this method does NOT create or update the router. (routers.preview)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to query.
* @param Router $postBody
* @param array $optParams Optional parameters.
* @return RoutersPreviewResponse
* @throws \Google\Service\Exception
*/
public function preview($project, $region, $router, Router $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('preview', [$params], RoutersPreviewResponse::class);
}
/**
* Updates the specified Router resource with the data included in the request.
* This method conforms toPUT semantics, which requests that the state of the
* target resource be created or replaced with the state defined by the
* representation enclosed in the request message payload. (routers.update)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource to update.
* @param Router $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
* @throws \Google\Service\Exception
*/
public function update($project, $region, $router, Router $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], Operation::class);
}
/**
* Updates or creates new Route Policy (routers.updateRoutePolicy)
*
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $router Name of the Router resource where Route Policy is
* defined.
* @param RoutePolicy $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
* @throws \Google\Service\Exception
*/
public function updateRoutePolicy($project, $region, $router, RoutePolicy $postBody, $optParams = [])
{
$params = ['project' => $project, 'region' => $region, 'router' => $router, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateRoutePolicy', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Routers::class, 'Google_Service_Compute_Resource_Routers');
← Back