File "ProjectsLocationsVmwareengineGlobalNetworkPeerings.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/VMwareEngine/Resource/ProjectsLocationsVmwareengineGlobalNetworkPeerings.php
File size: 10.65 KB
MIME-type: text/x-php
Charset: utf-8
<?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\VMwareEngine\Resource;
use Google\Service\VMwareEngine\ListNetworkPeeringsResponse;
use Google\Service\VMwareEngine\NetworkPeering;
use Google\Service\VMwareEngine\Operation;
/**
* The "networkPeerings" collection of methods.
* Typical usage is:
* <code>
* $vmwareengineService = new Google\Service\VMwareEngine(...);
* $networkPeerings = $vmwareengineService->projects_locations_global_networkPeerings;
* </code>
*/
class ProjectsLocationsVmwareengineGlobalNetworkPeerings extends \Google\Service\Resource
{
/**
* Creates a new network peering between the peer network and VMware Engine
* network provided in a `NetworkPeering` resource. (networkPeerings.create)
*
* @param string $parent Required. The resource name of the location to create
* the new network peering in. This value is always `global`, because
* `NetworkPeering` is a global resource. Resource names are schemeless URIs
* that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global`
* @param NetworkPeering $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string networkPeeringId Required. The user-provided identifier of
* the new `NetworkPeering`. This identifier must be unique among
* `NetworkPeering` resources within the parent and becomes the final token in
* the name URI. The identifier must meet the following requirements: * Only
* contains 1-63 alphanumeric characters and hyphens * Begins with an
* alphabetical character * Ends with a non-hyphen character * Not formatted as
* a UUID * Complies with [RFC
* 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
* @opt_param string requestId Optional. A 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. The
* server guarantees that a request doesn't result in creation of duplicate
* commitments for at least 60 minutes. 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 create($parent, NetworkPeering $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a `NetworkPeering` resource. When a network peering is deleted for a
* VMware Engine network, the peer network becomes inaccessible to that VMware
* Engine network. (networkPeerings.delete)
*
* @param string $name Required. The resource name of the network peering to be
* deleted. Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global/networkPeerings/my-peering`
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. A 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. The
* server guarantees that a request doesn't result in creation of duplicate
* commitments for at least 60 minutes. 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($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Retrieves a `NetworkPeering` resource by its resource name. The resource
* contains details of the network peering, such as peered networks, import and
* export custom route configurations, and peering state. (networkPeerings.get)
*
* @param string $name Required. The resource name of the network peering to
* retrieve. Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global/networkPeerings/my-peering`
* @param array $optParams Optional parameters.
* @return NetworkPeering
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], NetworkPeering::class);
}
/**
* Lists `NetworkPeering` resources in a given project.
* (networkPeerings.listProjectsLocationsVmwareengineGlobalNetworkPeerings)
*
* @param string $parent Required. The resource name of the location (global) to
* query for network peerings. Resource names are schemeless URIs that follow
* the conventions in https://cloud.google.com/apis/design/resource_names. For
* example: `projects/my-project/locations/global`
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that matches resources returned
* in the response. The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value must be
* a string, a number, or a boolean. The comparison operator must be `=`, `!=`,
* `>`, or `<`. For example, if you are filtering a list of network peerings,
* you can exclude the ones named `example-peering` by specifying `name !=
* "example-peering"`. To filter on multiple expressions, provide each separate
* expression within parentheses. For example: ``` (name = "example-peering")
* (createTime > "2021-04-12T08:15:10.40Z") ``` By default, each expression is
* an `AND` expression. However, you can include `AND` and `OR` expressions
* explicitly. For example: ``` (name = "example-peering-1") AND (createTime >
* "2021-04-12T08:15:10.40Z") OR (name = "example-peering-2") ```
* @opt_param string orderBy Sorts list results by a certain order. By default,
* returned results are ordered by `name` in ascending order. You can also sort
* results in descending order based on the `name` value using `orderBy="name
* desc"`. Currently, only ordering by `name` is supported.
* @opt_param int pageSize The maximum number of network peerings to return in
* one page. The maximum value is coerced to 1000. The default value of this
* field is 500.
* @opt_param string pageToken A page token, received from a previous
* `ListNetworkPeerings` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListNetworkPeerings` must
* match the call that provided the page token.
* @return ListNetworkPeeringsResponse
*/
public function listProjectsLocationsVmwareengineGlobalNetworkPeerings($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListNetworkPeeringsResponse::class);
}
/**
* Modifies a `NetworkPeering` resource. Only the `description` field can be
* updated. Only fields specified in `updateMask` are applied.
* (networkPeerings.patch)
*
* @param string $name Output only. The resource name of the network peering.
* Resource names are scheme-less URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global/networkPeerings/my-peering`
* @param NetworkPeering $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. A 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. The
* server guarantees that a request doesn't result in creation of duplicate
* commitments for at least 60 minutes. 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 string updateMask Required. Field mask is used to specify the
* fields to be overwritten in the `NetworkPeering` resource by the update. The
* fields specified in the `update_mask` are relative to the resource, not the
* full request. A field will be overwritten if it is in the mask. If the user
* does not provide a mask then all fields will be overwritten.
* @return Operation
*/
public function patch($name, NetworkPeering $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsVmwareengineGlobalNetworkPeerings::class, 'Google_Service_VMwareEngine_Resource_ProjectsLocationsVmwareengineGlobalNetworkPeerings');