Google BigQuery Connection V1 Client - Class ConnectionServiceClient (2.0.0)

Namespace

Methods

__construct

createConnection

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\BigQuery\Connection\V1\Connection;
use Google\Cloud\BigQuery\Connection\V1\CreateConnectionRequest;

/**
 * @param string $formattedParent Parent resource name.
 *                                Must be in the format `projects/{project_id}/locations/{location_id}`
 *                                Please see {@see ConnectionServiceClient::locationName()} for help formatting this field.
 */
function create_connection_sample(string $formattedParent): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

    // Prepare the request message.
    $connection = new Connection();
    $request = (new CreateConnectionRequest())
        ->setParent($formattedParent)
        ->setConnection($connection);

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

    create_connection_sample($formattedParent);
}

deleteConnection

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\BigQuery\Connection\V1\DeleteConnectionRequest;

/**
 * @param string $formattedName Name of the deleted connection, for example:
 *                              `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
 *                              Please see {@see ConnectionServiceClient::connectionName()} for help formatting this field.
 */
function delete_connection_sample(string $formattedName): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $connectionServiceClient->deleteConnection($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = ConnectionServiceClient::connectionName('[PROJECT]', '[LOCATION]', '[CONNECTION]');

    delete_connection_sample($formattedName);
}

getConnection

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\BigQuery\Connection\V1\Connection;
use Google\Cloud\BigQuery\Connection\V1\GetConnectionRequest;

/**
 * @param string $formattedName Name of the requested connection, for example:
 *                              `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
 *                              Please see {@see ConnectionServiceClient::connectionName()} for help formatting this field.
 */
function get_connection_sample(string $formattedName): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Connection $response */
        $response = $connectionServiceClient->getConnection($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 = ConnectionServiceClient::connectionName('[PROJECT]', '[LOCATION]', '[CONNECTION]');

    get_connection_sample($formattedName);
}

getIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $connectionServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

listConnections

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\BigQuery\Connection\V1\Connection;
use Google\Cloud\BigQuery\Connection\V1\ListConnectionsRequest;

/**
 * @param string $formattedParent Parent resource name.
 *                                Must be in the form: `projects/{project_id}/locations/{location_id}`
 *                                Please see {@see ConnectionServiceClient::locationName()} for help formatting this field.
 * @param int    $pageSize        The maximum number of resources contained in the underlying API
 *                                response. The API may return fewer values in a page, even if
 *                                there are additional values to be retrieved.
 */
function list_connections_sample(string $formattedParent, int $pageSize): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

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

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

        /** @var Connection $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 = ConnectionServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $pageSize = 0;

    list_connections_sample($formattedParent, $pageSize);
}

setIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $connectionServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $connectionServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

updateConnection

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Connection\V1\Client\ConnectionServiceClient;
use Google\Cloud\BigQuery\Connection\V1\Connection;
use Google\Cloud\BigQuery\Connection\V1\UpdateConnectionRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedName Name of the connection to update, for example:
 *                              `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
 *                              Please see {@see ConnectionServiceClient::connectionName()} for help formatting this field.
 */
function update_connection_sample(string $formattedName): void
{
    // Create a client.
    $connectionServiceClient = new ConnectionServiceClient();

    // Prepare the request message.
    $connection = new Connection();
    $updateMask = new FieldMask();
    $request = (new UpdateConnectionRequest())
        ->setName($formattedName)
        ->setConnection($connection)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Connection $response */
        $response = $connectionServiceClient->updateConnection($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 = ConnectionServiceClient::connectionName('[PROJECT]', '[LOCATION]', '[CONNECTION]');

    update_connection_sample($formattedName);
}

createConnectionAsync

deleteConnectionAsync

getConnectionAsync

getIamPolicyAsync

listConnectionsAsync

setIamPolicyAsync

testIamPermissionsAsync

updateConnectionAsync

static::clusterName

static::connectionName

static::locationName

static::serviceName

static::parseName