create_instance.php

<?php
/*
 * Copyright 2026 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * GENERATED CODE WARNING
 * This file was automatically generated - do not edit!
 */

require_once __DIR__ . '/../../../vendor/autoload.php';

// [START bigtableadmin_v2_generated_BigtableInstanceAdmin_CreateInstance_sync]
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Bigtable\Admin\V2\Client\BigtableInstanceAdminClient;
use Google\Cloud\Bigtable\Admin\V2\CreateInstanceRequest;
use Google\Cloud\Bigtable\Admin\V2\Instance;
use Google\Rpc\Status;

/**
 * Create an instance within a project.
 *
 * Note that exactly one of Cluster.serve_nodes and
 * Cluster.cluster_config.cluster_autoscaling_config can be set. If
 * serve_nodes is set to non-zero, then the cluster is manually scaled. If
 * cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
 * enabled.
 *
 * @param string $formattedParent     The unique name of the project in which to create the new
 *                                    instance. Values are of the form `projects/{project}`. Please see
 *                                    {@see BigtableInstanceAdminClient::projectName()} for help formatting this field.
 * @param string $instanceId          The ID to be used when referring to the new instance within its
 *                                    project, e.g., just `myinstance` rather than
 *                                    `projects/myproject/instances/myinstance`.
 * @param string $instanceDisplayName The descriptive name for this instance as it appears in UIs.
 *                                    Can be changed at any time, but should be kept globally unique
 *                                    to avoid confusion.
 */
function create_instance_sample(
    string $formattedParent,
    string $instanceId,
    string $instanceDisplayName
): void {
    // Create a client.
    $bigtableInstanceAdminClient = new BigtableInstanceAdminClient();

    // Prepare the request message.
    $instance = (new Instance())
        ->setDisplayName($instanceDisplayName);
    $clusters = [];
    $request = (new CreateInstanceRequest())
        ->setParent($formattedParent)
        ->setInstanceId($instanceId)
        ->setInstance($instance)
        ->setClusters($clusters);

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

        if ($response->operationSucceeded()) {
            /** @var Instance $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 = BigtableInstanceAdminClient::projectName('[PROJECT]');
    $instanceId = '[INSTANCE_ID]';
    $instanceDisplayName = '[DISPLAY_NAME]';

    create_instance_sample($formattedParent, $instanceId, $instanceDisplayName);
}
// [END bigtableadmin_v2_generated_BigtableInstanceAdmin_CreateInstance_sync]