Reference documentation and code samples for the Google Cloud Vpc Access V1 Client class VpcAccessServiceClient.
Service Description: Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$vpcAccessServiceClient = new VpcAccessServiceClient();
try {
$formattedParent = $vpcAccessServiceClient->locationName('[PROJECT]', '[LOCATION]');
$connectorId = 'connector_id';
$connector = new Connector();
$operationResponse = $vpcAccessServiceClient->createConnector($formattedParent, $connectorId, $connector);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $vpcAccessServiceClient->createConnector($formattedParent, $connectorId, $connector);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $vpcAccessServiceClient->resumeOperation($operationName, 'createConnector');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$vpcAccessServiceClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient to use the new surface.
Namespace
Google \ Cloud \ VpcAccess \ V1Methods
__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.
↳ 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. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. 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 = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods 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.
createConnector
Creates a Serverless VPC Access connector, returns an operation.
parent
string
Required. The project and location in which the configuration should be created,
specified in the format projects/*/locations/*
.
connectorId
string
Required. The ID to use for this connector.
connector
optionalArgs
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\VpcAccess\V1\Connector;
use Google\Cloud\VpcAccess\V1\VpcAccessServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The project and location in which the configuration should be created,
* specified in the format `projects/*/locations/*`. Please see
* {@see VpcAccessServiceClient::locationName()} for help formatting this field.
* @param string $connectorId The ID to use for this connector.
*/
function create_connector_sample(string $formattedParent, string $connectorId): void
{
// Create a client.
$vpcAccessServiceClient = new VpcAccessServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$connector = new Connector();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vpcAccessServiceClient->createConnector($formattedParent, $connectorId, $connector);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Connector $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} 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
{
$formattedParent = VpcAccessServiceClient::locationName('[PROJECT]', '[LOCATION]');
$connectorId = '[CONNECTOR_ID]';
create_connector_sample($formattedParent, $connectorId);
}
deleteConnector
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
name
string
Required. Name of a Serverless VPC Access connector to delete.
optionalArgs
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\VpcAccess\V1\VpcAccessServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName Name of a Serverless VPC Access connector to delete. Please see
* {@see VpcAccessServiceClient::connectorName()} for help formatting this field.
*/
function delete_connector_sample(string $formattedName): void
{
// Create a client.
$vpcAccessServiceClient = new VpcAccessServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vpcAccessServiceClient->deleteConnector($formattedName);
$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
{
$formattedName = VpcAccessServiceClient::connectorName('[PROJECT]', '[LOCATION]', '[CONNECTOR]');
delete_connector_sample($formattedName);
}
getConnector
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
name
string
Required. Name of a Serverless VPC Access connector to get.
optionalArgs
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\VpcAccess\V1\Connector;
use Google\Cloud\VpcAccess\V1\VpcAccessServiceClient;
/**
* @param string $formattedName Name of a Serverless VPC Access connector to get. Please see
* {@see VpcAccessServiceClient::connectorName()} for help formatting this field.
*/
function get_connector_sample(string $formattedName): void
{
// Create a client.
$vpcAccessServiceClient = new VpcAccessServiceClient();
// Call the API and handle any network failures.
try {
/** @var Connector $response */
$response = $vpcAccessServiceClient->getConnector($formattedName);
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
{
$formattedName = VpcAccessServiceClient::connectorName('[PROJECT]', '[LOCATION]', '[CONNECTOR]');
get_connector_sample($formattedName);
}
listConnectors
Lists Serverless VPC Access connectors.
parent
string
Required. The project and location from which the routes should be listed.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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\VpcAccess\V1\Connector;
use Google\Cloud\VpcAccess\V1\VpcAccessServiceClient;
/**
* @param string $formattedParent The project and location from which the routes should be listed. Please see
* {@see VpcAccessServiceClient::locationName()} for help formatting this field.
*/
function list_connectors_sample(string $formattedParent): void
{
// Create a client.
$vpcAccessServiceClient = new VpcAccessServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vpcAccessServiceClient->listConnectors($formattedParent);
/** @var Connector $element */
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
{
$formattedParent = VpcAccessServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_connectors_sample($formattedParent);
}
listLocations
Lists information about the supported locations for this service.
optionalArgs
array
Optional.
↳ name
string
The resource that owns the locations collection, if applicable.
↳ filter
string
The standard list filter.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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\Location\Location;
use Google\Cloud\VpcAccess\V1\VpcAccessServiceClient;
/**
* 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 list_locations_sample(): void
{
// Create a client.
$vpcAccessServiceClient = new VpcAccessServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vpcAccessServiceClient->listLocations();
/** @var Location $element */
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());
}
}
getOperationsClient
Return an OperationsClient 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
static::connectorName
Formats a string containing the fully-qualified path to represent a connector resource.
project
string
location
string
connector
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- connector: projects/{project}/locations/{location}/connectors/{connector}
- location: projects/{project}/locations/{location}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
Constants
SERVICE_NAME
Value: 'google.cloud.vpcaccess.v1.VpcAccessService'
The name of the service.
SERVICE_ADDRESS
Value: 'vpcaccess.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.
