326 lines
18 KiB
PHP
326 lines
18 KiB
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\InterconnectAttachment;
|
|
use Google\Service\Compute\InterconnectAttachmentAggregatedList;
|
|
use Google\Service\Compute\InterconnectAttachmentList;
|
|
use Google\Service\Compute\Operation;
|
|
use Google\Service\Compute\RegionSetLabelsRequest;
|
|
|
|
/**
|
|
* The "interconnectAttachments" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $computeService = new Google\Service\Compute(...);
|
|
* $interconnectAttachments = $computeService->interconnectAttachments;
|
|
* </code>
|
|
*/
|
|
class InterconnectAttachments extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Retrieves an aggregated list of interconnect attachments. To prevent failure,
|
|
* Google recommends that you set the `returnPartialSuccess` parameter to
|
|
* `true`. (interconnectAttachments.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 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`. 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 InterconnectAttachmentAggregatedList
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function aggregatedList($project, $optParams = [])
|
|
{
|
|
$params = ['project' => $project];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('aggregatedList', [$params], InterconnectAttachmentAggregatedList::class);
|
|
}
|
|
/**
|
|
* Deletes the specified interconnect attachment.
|
|
* (interconnectAttachments.delete)
|
|
*
|
|
* @param string $project Project ID for this request.
|
|
* @param string $region Name of the region for this request.
|
|
* @param string $interconnectAttachment Name of the interconnect attachment 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, $interconnectAttachment, $optParams = [])
|
|
{
|
|
$params = ['project' => $project, 'region' => $region, 'interconnectAttachment' => $interconnectAttachment];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Returns the specified interconnect attachment. (interconnectAttachments.get)
|
|
*
|
|
* @param string $project Project ID for this request.
|
|
* @param string $region Name of the region for this request.
|
|
* @param string $interconnectAttachment Name of the interconnect attachment to
|
|
* return.
|
|
* @param array $optParams Optional parameters.
|
|
* @return InterconnectAttachment
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($project, $region, $interconnectAttachment, $optParams = [])
|
|
{
|
|
$params = ['project' => $project, 'region' => $region, 'interconnectAttachment' => $interconnectAttachment];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], InterconnectAttachment::class);
|
|
}
|
|
/**
|
|
* Creates an InterconnectAttachment in the specified project using the data
|
|
* included in the request. (interconnectAttachments.insert)
|
|
*
|
|
* @param string $project Project ID for this request.
|
|
* @param string $region Name of the region for this request.
|
|
* @param InterconnectAttachment $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).
|
|
* @opt_param bool validateOnly If true, the request will not be committed.
|
|
* @return Operation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function insert($project, $region, InterconnectAttachment $postBody, $optParams = [])
|
|
{
|
|
$params = ['project' => $project, 'region' => $region, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('insert', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Retrieves the list of interconnect attachments contained within the specified
|
|
* region. (interconnectAttachments.listInterconnectAttachments)
|
|
*
|
|
* @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 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`. 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 InterconnectAttachmentList
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listInterconnectAttachments($project, $region, $optParams = [])
|
|
{
|
|
$params = ['project' => $project, 'region' => $region];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], InterconnectAttachmentList::class);
|
|
}
|
|
/**
|
|
* Updates the specified interconnect attachment with the data included in the
|
|
* request. This method supports PATCH semantics and uses the JSON merge patch
|
|
* format and processing rules. (interconnectAttachments.patch)
|
|
*
|
|
* @param string $project Project ID for this request.
|
|
* @param string $region Name of the region scoping this request.
|
|
* @param string $interconnectAttachment Name of the interconnect attachment to
|
|
* patch.
|
|
* @param InterconnectAttachment $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, $interconnectAttachment, InterconnectAttachment $postBody, $optParams = [])
|
|
{
|
|
$params = ['project' => $project, 'region' => $region, 'interconnectAttachment' => $interconnectAttachment, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('patch', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Sets the labels on an InterconnectAttachment. To learn more about labels,
|
|
* read the Labeling Resources documentation.
|
|
* (interconnectAttachments.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
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
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);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(InterconnectAttachments::class, 'Google_Service_Compute_Resource_InterconnectAttachments');
|