Google Cloud Vpc Access V1 Client - Class VpcAccessServiceClient (2.0.1)

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.

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.

Namespace

Google \ Cloud \ VpcAccess \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`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.

The async variant is Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient::createConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\CreateConnectorRequest` 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.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient;
use Google\Cloud\VpcAccess\V1\Connector;
use Google\Cloud\VpcAccess\V1\CreateConnectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project and location in which the configuration should be created,
 *                                specified in the format `projects/&#42;/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 the request message.
    $connector = new Connector();
    $request = (new CreateConnectorRequest())
        ->setParent($formattedParent)
        ->setConnectorId($connectorId)
        ->setConnector($connector);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vpcAccessServiceClient->createConnector($request);
        $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.

The async variant is Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient::deleteConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\DeleteConnectorRequest` 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.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient;
use Google\Cloud\VpcAccess\V1\DeleteConnectorRequest;
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();

    // Prepare the request message.
    $request = (new DeleteConnectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vpcAccessServiceClient->deleteConnector($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
{
    $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.

The async variant is Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient::getConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\GetConnectorRequest` 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.

Returns
Type	Description
`Google\Cloud\VpcAccess\V1\Connector`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient;
use Google\Cloud\VpcAccess\V1\Connector;
use Google\Cloud\VpcAccess\V1\GetConnectorRequest;

/**
 * @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();

    // Prepare the request message.
    $request = (new GetConnectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Connector $response */
        $response = $vpcAccessServiceClient->getConnector($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
{
    $formattedName = VpcAccessServiceClient::connectorName('[PROJECT]', '[LOCATION]', '[CONNECTOR]');

    get_connector_sample($formattedName);
}

listConnectors

Lists Serverless VPC Access connectors.

The async variant is Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient::listConnectorsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\ListConnectorsRequest` 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.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient;
use Google\Cloud\VpcAccess\V1\Connector;
use Google\Cloud\VpcAccess\V1\ListConnectorsRequest;

/**
 * @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();

    // Prepare the request message.
    $request = (new ListConnectorsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vpcAccessServiceClient->listConnectors($request);

        /** @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.

The async variant is Google\Cloud\VpcAccess\V1\Client\VpcAccessServiceClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` 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.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\VpcAccess\V1\Client\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();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vpcAccessServiceClient->listLocations($request);

        /** @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());
    }
}

createConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\CreateConnectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\DeleteConnectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\GetConnectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listConnectorsAsync

Parameters
Name	Description
`request`	`Google\Cloud\VpcAccess\V1\ListConnectorsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\LongRunning\Client\OperationsClient`

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.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::connectorName

Formats a string containing the fully-qualified path to represent a connector resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`connector`	`string`

Returns
Type	Description
`string`	The formatted connector resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

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.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.