/var/www/vhosts/ihelp.ro/httpdocs/vendor/google/apiclient-services/src/Compute/Resource
Edit: /var/www/vhosts/ihelp.ro/httpdocs/vendor/google/apiclient-services/src/Compute/Resource/Routers.php (24045B)
* $computeService = new Google\Service\Compute(...);
* $routers = $computeService->routers;
*
*/
class Routers extends \Google\Service\Resource
{
/**
* Retrieves an aggregated list of routers. (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. 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 RouterAggregatedList
*/
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
*/
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);
}
/**
* 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
*/
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
*/
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. 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 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.
* @return VmEndpointNatMappingsList
*/
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);
}
/**
* 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
*/
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
*/
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. 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 RouterList
*/
public function listRouters($project, $region, $optParams = [])
{
$params = ['project' => $project, 'region' => $region];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], RouterList::class);
}
/**
* Patches the specified Router resource with the data included in the request.
* This method supports PATCH semantics and uses JSON 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
*/
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);
}
/**
* Preview fields auto-generated during router create and update 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
*/
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 to PUT 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
*/
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);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Routers::class, 'Google_Service_Compute_Resource_Routers');