Google Cloud Capacity Planner V1beta Client - Class CapacityPlanningServiceClient (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class CapacityPlanningServiceClient.

Service Description: This API allows users to plan for GCP capacity associated with their projects. Users can request additional capacity for GCP resources such as VMs, PDs, etc.

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 \ CapacityPlanner \ V1beta \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array|Google\ApiCore\Options\ClientOptions 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	FetchAuthTokenInterface|CredentialsWrapper This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\CapacityPlanner\V1beta\CapacityPlanningServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new CapacityPlanningServiceClient(['credentials' => $creds]); 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. 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.
↳ logger	false|LoggerInterface A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
↳ universeDomain	string The service domain for the client. Defaults to 'googleapis.com'.

getCapacityPlan

Returns information about the capacity plan.

The async variant is CapacityPlanningServiceClient::getCapacityPlanAsync() .

Parameters
Name	Description
request	Google\Cloud\CapacityPlanner\V1beta\GetCapacityPlanRequest 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\CapacityPlanner\V1beta\CapacityPlan

Example

use Google\ApiCore\ApiException;
use Google\Cloud\CapacityPlanner\V1beta\CapacityPlan;
use Google\Cloud\CapacityPlanner\V1beta\Client\CapacityPlanningServiceClient;
use Google\Cloud\CapacityPlanner\V1beta\GetCapacityPlanRequest;

/**
 * @param string $formattedName The name of the capacity plan to retrieve.
 *                              Format: projects/{project}/capacityPlans/{capacity_plan}
 *                              Please see {@see CapacityPlanningServiceClient::capacityPlanName()} for help formatting this field.
 */
function get_capacity_plan_sample(string $formattedName): void
{
    // Create a client.
    $capacityPlanningServiceClient = new CapacityPlanningServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CapacityPlan $response */
        $response = $capacityPlanningServiceClient->getCapacityPlan($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 = CapacityPlanningServiceClient::capacityPlanName('[PROJECT]', '[CAPACITY_PLAN]');

    get_capacity_plan_sample($formattedName);
}

queryCapacityPlanInsights

Query capacity plan insights that are in the parent parameter and match your specified filters.

The async variant is CapacityPlanningServiceClient::queryCapacityPlanInsightsAsync() .

Parameters
Name	Description
request	Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlanInsightsRequest 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\CapacityPlanner\V1beta\QueryCapacityPlanInsightsResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\CapacityPlanner\V1beta\CapacityPlanFilters;
use Google\Cloud\CapacityPlanner\V1beta\CapacityPlanKey;
use Google\Cloud\CapacityPlanner\V1beta\CapacityType;
use Google\Cloud\CapacityPlanner\V1beta\Client\CapacityPlanningServiceClient;
use Google\Cloud\CapacityPlanner\V1beta\LocationIdentifier;
use Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlanInsightsRequest;
use Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlanInsightsResponse;
use Google\Cloud\CapacityPlanner\V1beta\ResourceContainer;
use Google\Cloud\CapacityPlanner\V1beta\ResourceIdKey;
use Google\Cloud\CapacityPlanner\V1beta\ResourceIdentifier;

/**
 * @param string $parent                                           The parent resource container.
 *                                                                 Format: projects/{project}
 * @param string $capacityPlanFiltersKeysResourceContainerId       Identifier of the resource container. For example, project number
 *                                                                 for project type.
 * @param string $capacityPlanFiltersKeysResourceIdKeyResourceCode resource_code for the resource. eg: gce-ram, gce-vcpus,
 *                                                                 gce-gpu, gce-tpu, gce-vm, gce-persistent-disk, gce-local-ssd.
 * @param string $capacityPlanFiltersKeysLocationIdSource          Location where resource is sourced. For Cloud Storage, the
 *                                                                 alphabetically first location is the source.
 * @param int    $capacityPlanFiltersCapacityTypesElement          The capacity types to include in the response.
 */
function query_capacity_plan_insights_sample(
    string $parent,
    string $capacityPlanFiltersKeysResourceContainerId,
    string $capacityPlanFiltersKeysResourceIdKeyResourceCode,
    string $capacityPlanFiltersKeysLocationIdSource,
    int $capacityPlanFiltersCapacityTypesElement
): void {
    // Create a client.
    $capacityPlanningServiceClient = new CapacityPlanningServiceClient();

    // Prepare the request message.
    $capacityPlanFiltersKeysResourceContainer = (new ResourceContainer())
        ->setId($capacityPlanFiltersKeysResourceContainerId);
    $capacityPlanFiltersKeysResourceIdKeyResourceId = new ResourceIdentifier();
    $capacityPlanFiltersKeysResourceIdKey = (new ResourceIdKey())
        ->setResourceCode($capacityPlanFiltersKeysResourceIdKeyResourceCode)
        ->setResourceId($capacityPlanFiltersKeysResourceIdKeyResourceId);
    $capacityPlanFiltersKeysLocationId = (new LocationIdentifier())
        ->setSource($capacityPlanFiltersKeysLocationIdSource);
    $capacityPlanKey = (new CapacityPlanKey())
        ->setResourceContainer($capacityPlanFiltersKeysResourceContainer)
        ->setResourceIdKey($capacityPlanFiltersKeysResourceIdKey)
        ->setLocationId($capacityPlanFiltersKeysLocationId);
    $capacityPlanFiltersKeys = [$capacityPlanKey,];
    $capacityPlanFiltersCapacityTypes = [$capacityPlanFiltersCapacityTypesElement,];
    $capacityPlanFilters = (new CapacityPlanFilters())
        ->setKeys($capacityPlanFiltersKeys)
        ->setCapacityTypes($capacityPlanFiltersCapacityTypes);
    $request = (new QueryCapacityPlanInsightsRequest())
        ->setParent($parent)
        ->setCapacityPlanFilters($capacityPlanFilters);

    // Call the API and handle any network failures.
    try {
        /** @var QueryCapacityPlanInsightsResponse $response */
        $response = $capacityPlanningServiceClient->queryCapacityPlanInsights($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
{
    $parent = '[PARENT]';
    $capacityPlanFiltersKeysResourceContainerId = '[ID]';
    $capacityPlanFiltersKeysResourceIdKeyResourceCode = '[RESOURCE_CODE]';
    $capacityPlanFiltersKeysLocationIdSource = '[SOURCE]';
    $capacityPlanFiltersCapacityTypesElement = CapacityType::CAPACITY_TYPE_UNKNOWN;

    query_capacity_plan_insights_sample(
        $parent,
        $capacityPlanFiltersKeysResourceContainerId,
        $capacityPlanFiltersKeysResourceIdKeyResourceCode,
        $capacityPlanFiltersKeysLocationIdSource,
        $capacityPlanFiltersCapacityTypesElement
    );
}

queryCapacityPlans

Returns a list of the capacity plans that are in the parent parameter and match your specified filters.

(The maximum list length is limited by the pageSize parameter.)

The async variant is CapacityPlanningServiceClient::queryCapacityPlansAsync() .

Parameters
Name	Description
request	Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlansRequest 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\CapacityPlanner\V1beta\CapacityPlan;
use Google\Cloud\CapacityPlanner\V1beta\Client\CapacityPlanningServiceClient;
use Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlansRequest;

/**
 * @param string $formattedParent The parent resource container.
 *                                Format:
 *                                projects/{project} or
 *                                folders/{folder} or
 *                                organizations/{organization}
 *                                Please see {@see CapacityPlanningServiceClient::projectName()} for help formatting this field.
 */
function query_capacity_plans_sample(string $formattedParent): void
{
    // Create a client.
    $capacityPlanningServiceClient = new CapacityPlanningServiceClient();

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

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

        /** @var CapacityPlan $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 = CapacityPlanningServiceClient::projectName('[PROJECT]');

    query_capacity_plans_sample($formattedParent);
}

getCapacityPlanAsync

Parameters
Name	Description
request	Google\Cloud\CapacityPlanner\V1beta\GetCapacityPlanRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\CapacityPlanner\V1beta\CapacityPlan>

queryCapacityPlanInsightsAsync

Parameters
Name	Description
request	Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlanInsightsRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlanInsightsResponse>

queryCapacityPlansAsync

Parameters
Name	Description
request	Google\Cloud\CapacityPlanner\V1beta\QueryCapacityPlansRequest
optionalArgs	array

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

static::capacityPlanName

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

Parameters
Name	Description
project	string
capacityPlan	string

Returns
Type	Description
string	The formatted capacity_plan resource.

static::projectName

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

Parameter
Name	Description
project	string

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

• capacityPlan: projects/{project}/capacityPlans/{capacity_plan}
• project: projects/{project}

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.