Google Cloud Api Hub V1 Client - Class ProvisioningClient (0.1.2)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ProvisioningClient.

Service Description: This service is used for managing the data plane provisioning of the API hub.

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 \ ApiHub \ 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. 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.

createApiHubInstance

Provisions instance resources for the API Hub.

The async variant is ProvisioningClient::createApiHubInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiHub\V1\CreateApiHubInstanceRequest` 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\ApiHub\V1\ApiHubInstance;
use Google\Cloud\ApiHub\V1\ApiHubInstance\Config;
use Google\Cloud\ApiHub\V1\Client\ProvisioningClient;
use Google\Cloud\ApiHub\V1\CreateApiHubInstanceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                 The parent resource for the Api Hub instance resource.
 *                                                Format: `projects/{project}/locations/{location}`
 *                                                Please see {@see ProvisioningClient::locationName()} for help formatting this field.
 * @param string $apiHubInstanceConfigCmekKeyName The Customer Managed Encryption Key (CMEK) used for data
 *                                                encryption. The CMEK name should follow the format of
 *                                                `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
 *                                                where the location must match the instance location.
 */
function create_api_hub_instance_sample(
    string $formattedParent,
    string $apiHubInstanceConfigCmekKeyName
): void {
    // Create a client.
    $provisioningClient = new ProvisioningClient();

    // Prepare the request message.
    $apiHubInstanceConfig = (new Config())
        ->setCmekKeyName($apiHubInstanceConfigCmekKeyName);
    $apiHubInstance = (new ApiHubInstance())
        ->setConfig($apiHubInstanceConfig);
    $request = (new CreateApiHubInstanceRequest())
        ->setParent($formattedParent)
        ->setApiHubInstance($apiHubInstance);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $provisioningClient->createApiHubInstance($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ApiHubInstance $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 = ProvisioningClient::locationName('[PROJECT]', '[LOCATION]');
    $apiHubInstanceConfigCmekKeyName = '[CMEK_KEY_NAME]';

    create_api_hub_instance_sample($formattedParent, $apiHubInstanceConfigCmekKeyName);
}

getApiHubInstance

Gets details of a single API Hub instance.

The async variant is ProvisioningClient::getApiHubInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiHub\V1\GetApiHubInstanceRequest` 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\ApiHub\V1\ApiHubInstance`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ApiHub\V1\ApiHubInstance;
use Google\Cloud\ApiHub\V1\Client\ProvisioningClient;
use Google\Cloud\ApiHub\V1\GetApiHubInstanceRequest;

/**
 * @param string $formattedName The name of the Api Hub instance to retrieve.
 *                              Format:
 *                              `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. Please see
 *                              {@see ProvisioningClient::apiHubInstanceName()} for help formatting this field.
 */
function get_api_hub_instance_sample(string $formattedName): void
{
    // Create a client.
    $provisioningClient = new ProvisioningClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ApiHubInstance $response */
        $response = $provisioningClient->getApiHubInstance($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 = ProvisioningClient::apiHubInstanceName(
        '[PROJECT]',
        '[LOCATION]',
        '[API_HUB_INSTANCE]'
    );

    get_api_hub_instance_sample($formattedName);
}

lookupApiHubInstance

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

The async variant is ProvisioningClient::lookupApiHubInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiHub\V1\LookupApiHubInstanceRequest` 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\ApiHub\V1\LookupApiHubInstanceResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ApiHub\V1\Client\ProvisioningClient;
use Google\Cloud\ApiHub\V1\LookupApiHubInstanceRequest;
use Google\Cloud\ApiHub\V1\LookupApiHubInstanceResponse;

/**
 * @param string $formattedParent There will always be only one Api Hub instance for a GCP project
 *                                across all locations.
 *                                The parent resource for the Api Hub instance resource.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see ProvisioningClient::locationName()} for help formatting this field.
 */
function lookup_api_hub_instance_sample(string $formattedParent): void
{
    // Create a client.
    $provisioningClient = new ProvisioningClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var LookupApiHubInstanceResponse $response */
        $response = $provisioningClient->lookupApiHubInstance($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
{
    $formattedParent = ProvisioningClient::locationName('[PROJECT]', '[LOCATION]');

    lookup_api_hub_instance_sample($formattedParent);
}

getLocation

Gets information about a location.

The async variant is ProvisioningClient::getLocationAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ApiHub\V1\Client\ProvisioningClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $provisioningClient = new ProvisioningClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $provisioningClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is ProvisioningClient::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\ApiHub\V1\Client\ProvisioningClient;
use Google\Cloud\Location\ListLocationsRequest;

/**
 * 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.
    $provisioningClient = new ProvisioningClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $provisioningClient->listLocations($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());
    }
}

createApiHubInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiHub\V1\CreateApiHubInstanceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getApiHubInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiHub\V1\GetApiHubInstanceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ApiHub\V1\ApiHubInstance>`

lookupApiHubInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiHub\V1\LookupApiHubInstanceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ApiHub\V1\LookupApiHubInstanceResponse>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

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::apiHubInstanceName

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

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

Returns
Type	Description
`string`	The formatted api_hub_instance 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

apiHubInstance: projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}
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.