README

Idiomatic PHP client for Google Cloud Capacity Planner.

👁 Latest Stable Version
👁 Packagist

• API documentation

NOTE: This repository is part of Google Cloud PHP. Any support requests, bug reports, or development contributions should be directed to that project.

Installation

To begin, install the preferred dependency manager for PHP, Composer.

Now, install this component:

$ composer require google/cloud-capacityplanner

Browse the complete list of Google Cloud APIs for PHP

This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits offered by gRPC (such as streaming methods) please see our gRPC installation guide.

Authentication

Please see our Authentication guide for more information on authenticating your client. Once authenticated, you'll be ready to start making requests.

Sample

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

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

See the samples directory for a canonical list of samples.

Debugging

Please see our Debugging guide for more information about the debugging tools.

Version

This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates.

Next Steps

1. Understand the official documentation.