📄 Source: ProjectsLocationsPrivateConnections.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\VMwareEngine\Resource;
use Google\Service\VMwareEngine\ListPrivateConnectionsResponse;
use Google\Service\VMwareEngine\Operation;
use Google\Service\VMwareEngine\PrivateConnection;
/**
* The "privateConnections" collection of methods.
* Typical usage is:
* <code>
* $vmwareengineService = new Google\Service\VMwareEngine(...);
* $privateConnections = $vmwareengineService->projects_locations_privateConnections;
* </code>
*/
class ProjectsLocationsPrivateConnections extends \Google\Service\Resource
{
/**
* Creates a new private connection that can be used for accessing private
* Clouds. (privateConnections.create)
*
* @param string $parent Required. The resource name of the location to create
* the new private connection in. Private connection is a regional 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/us-central1`
* @param PrivateConnection $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string privateConnectionId Required. The user-provided identifier
* of the new private connection. This identifier must be unique among private
* connection 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).
* @opt_param bool validateOnly Optional. If set to `true`, only validates the
* request but doesn’t execute the request. If set to `false`, validates and
* executes the request.
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, PrivateConnection $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a `PrivateConnection` resource. When a private connection is deleted
* for a VMware Engine network, the connected network becomes inaccessible to
* that VMware Engine network. (privateConnections.delete)
*
* @param string $name Required. The resource name of the private connection 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/us-central1/privateConnections/my-connection`
* @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
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Retrieves a `PrivateConnection` resource by its resource name. The resource
* contains details of the private connection, such as connected network,
* routing mode and state. (privateConnections.get)
*
* @param string $name Required. The resource name of the private connection 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/us-central1/privateConnections/my-connection`
* @param array $optParams Optional parameters.
* @return PrivateConnection
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], PrivateConnection::class);
}
/**
* Lists `PrivateConnection` resources in a given project and location.
* (privateConnections.listProjectsLocationsPrivateConnections)
*
* @param string $parent Required. The resource name of the location to query
* for private connections. Resource names are schemeless URIs that follow the
* conventions in https://cloud.google.com/apis/design/resource_names. For
* example: `projects/my-project/locations/us-central1`
* @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 private connections,
* you can exclude the ones named `example-connection` by specifying `name !=
* "example-connection"`. To filter on multiple expressions, provide each
* separate expression within parentheses. For example: ``` (name = "example-
* connection") (createTime > "2022-09-22T08:15:10.40Z") ``` By default, each
* expression is an `AND` expression. However, you can include `AND` and `OR`
* expressions explicitly. For example: ``` (name = "example-connection-1") AND
* (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-connection-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 private connections 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
* `ListPrivateConnections` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListPrivateConnections`
* must match the call that provided the page token.
* @return ListPrivateConnectionsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsPrivateConnections($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPrivateConnectionsResponse::class);
}
/**
* Modifies a `PrivateConnection` resource. Only `description` and
* `routing_mode` fields can be updated. Only fields specified in `updateMask`
* are applied. (privateConnections.patch)
*
* @param string $name Output only. The resource name of the private connection.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/us-central1/privateConnections/my-connection`
* @param PrivateConnection $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 `PrivateConnection` 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.
* @opt_param bool validateOnly Optional. If set to `true`, only validates the
* request but doesn’t execute the request. If set to `false`, validates and
* executes the request.
* @return Operation
* @throws \Google\Service\Exception
*/
public function patch($name, PrivateConnection $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(ProjectsLocationsPrivateConnections::class, 'Google_Service_VMwareEngine_Resource_ProjectsLocationsPrivateConnections');
← Back