Reference documentation and code samples for the Compute V1 Client class VpnTunnelsClient.
Service Description: The VpnTunnels API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important : If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. At the moment, supports only rest
. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
↳ logger
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
aggregatedList
Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
The async variant is VpnTunnelsClient::aggregatedListAsync() .
request
Google\Cloud\Compute\V1\AggregatedListVpnTunnelsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListVpnTunnelsRequest;
use Google\Cloud\Compute\V1\Client\VpnTunnelsClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$vpnTunnelsClient = new VpnTunnelsClient();
// Prepare the request message.
$request = (new AggregatedListVpnTunnelsRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vpnTunnelsClient->aggregatedList($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
aggregated_list_sample($project);
}
delete
Deletes the specified VpnTunnel resource.
The async variant is VpnTunnelsClient::deleteAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\VpnTunnelsClient;
use Google\Cloud\Compute\V1\DeleteVpnTunnelRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $vpnTunnel Name of the VpnTunnel resource to delete.
*/
function delete_sample(string $project, string $region, string $vpnTunnel): void
{
// Create a client.
$vpnTunnelsClient = new VpnTunnelsClient();
// Prepare the request message.
$request = (new DeleteVpnTunnelRequest())
->setProject($project)
->setRegion($region)
->setVpnTunnel($vpnTunnel);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vpnTunnelsClient->delete($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$region = '[REGION]';
$vpnTunnel = '[VPN_TUNNEL]';
delete_sample($project, $region, $vpnTunnel);
}
get
Returns the specified VpnTunnel resource.
The async variant is VpnTunnelsClient::getAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\VpnTunnelsClient;
use Google\Cloud\Compute\V1\GetVpnTunnelRequest;
use Google\Cloud\Compute\V1\VpnTunnel;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
* @param string $vpnTunnel Name of the VpnTunnel resource to return.
*/
function get_sample(string $project, string $region, string $vpnTunnel): void
{
// Create a client.
$vpnTunnelsClient = new VpnTunnelsClient();
// Prepare the request message.
$request = (new GetVpnTunnelRequest())
->setProject($project)
->setRegion($region)
->setVpnTunnel($vpnTunnel);
// Call the API and handle any network failures.
try {
/** @var VpnTunnel $response */
$response = $vpnTunnelsClient->get($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$region = '[REGION]';
$vpnTunnel = '[VPN_TUNNEL]';
get_sample($project, $region, $vpnTunnel);
}
insert
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
The async variant is VpnTunnelsClient::insertAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\VpnTunnelsClient;
use Google\Cloud\Compute\V1\InsertVpnTunnelRequest;
use Google\Cloud\Compute\V1\VpnTunnel;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function insert_sample(string $project, string $region): void
{
// Create a client.
$vpnTunnelsClient = new VpnTunnelsClient();
// Prepare the request message.
$vpnTunnelResource = new VpnTunnel();
$request = (new InsertVpnTunnelRequest())
->setProject($project)
->setRegion($region)
->setVpnTunnelResource($vpnTunnelResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vpnTunnelsClient->insert($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$region = '[REGION]';
insert_sample($project, $region);
}
list
Retrieves a list of VpnTunnel resources contained in the specified project and region.
The async variant is VpnTunnelsClient::listAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\VpnTunnelsClient;
use Google\Cloud\Compute\V1\ListVpnTunnelsRequest;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function list_sample(string $project, string $region): void
{
// Create a client.
$vpnTunnelsClient = new VpnTunnelsClient();
// Prepare the request message.
$request = (new ListVpnTunnelsRequest())
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vpnTunnelsClient->list($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$region = '[REGION]';
list_sample($project, $region);
}
setLabels
Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.
The async variant is VpnTunnelsClient::setLabelsAsync() .
request
Google\Cloud\Compute\V1\SetLabelsVpnTunnelRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\VpnTunnelsClient;
use Google\Cloud\Compute\V1\RegionSetLabelsRequest;
use Google\Cloud\Compute\V1\SetLabelsVpnTunnelRequest;
use Google\Rpc\Status;
/**
* @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.
*/
function set_labels_sample(string $project, string $region, string $resource): void
{
// Create a client.
$vpnTunnelsClient = new VpnTunnelsClient();
// Prepare the request message.
$regionSetLabelsRequestResource = new RegionSetLabelsRequest();
$request = (new SetLabelsVpnTunnelRequest())
->setProject($project)
->setRegion($region)
->setRegionSetLabelsRequestResource($regionSetLabelsRequestResource)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vpnTunnelsClient->setLabels($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$region = '[REGION]';
$resource = '[RESOURCE]';
set_labels_sample($project, $region, $resource);
}
aggregatedListAsync
optionalArgs
array
deleteAsync
optionalArgs
array
getAsync
insertAsync
optionalArgs
array
listAsync
optionalArgs
array
setLabelsAsync
optionalArgs
array
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
