Google Cloud BigQuery Data Exchange V1beta1 Client - Class AnalyticsHubServiceClient (0.3.3)

$analyticsHubServiceClient = new AnalyticsHubServiceClient();
try {
    $formattedParent = $analyticsHubServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $dataExchangeId = 'data_exchange_id';
    $dataExchange = new DataExchange();
    $response = $analyticsHubServiceClient->createDataExchange($formattedParent, $dataExchangeId, $dataExchange);
} finally {
    $analyticsHubServiceClient->close();
}

Namespace

Methods

__construct

createDataExchange

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\CreateDataExchangeRequest;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange;

/**
 * @param string $formattedParent         The parent resource path of the data exchange.
 *                                        e.g. `projects/myproject/locations/US`. Please see
 *                                        {@see AnalyticsHubServiceClient::locationName()} for help formatting this field.
 * @param string $dataExchangeId          The ID of the data exchange.
 *                                        Must contain only Unicode letters, numbers (0-9), underscores (_).
 *                                        Should not use characters that require URL-escaping, or characters
 *                                        outside of ASCII, spaces.
 *                                        Max length: 100 bytes.
 * @param string $dataExchangeDisplayName Human-readable display name of the data exchange. The display name must
 *                                        contain only Unicode letters, numbers (0-9), underscores (_), dashes (-),
 *                                        spaces ( ), ampersands (&) and must not start or end with spaces.
 *                                        Default value is an empty string.
 *                                        Max length: 63 bytes.
 */
function create_data_exchange_sample(
    string $formattedParent,
    string $dataExchangeId,
    string $dataExchangeDisplayName
): void {
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // Prepare the request message.
    $dataExchange = (new DataExchange())
        ->setDisplayName($dataExchangeDisplayName);
    $request = (new CreateDataExchangeRequest())
        ->setParent($formattedParent)
        ->setDataExchangeId($dataExchangeId)
        ->setDataExchange($dataExchange);

    // Call the API and handle any network failures.
    try {
        /** @var DataExchange $response */
        $response = $analyticsHubServiceClient->createDataExchange($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 = AnalyticsHubServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $dataExchangeId = '[DATA_EXCHANGE_ID]';
    $dataExchangeDisplayName = '[DISPLAY_NAME]';

    create_data_exchange_sample($formattedParent, $dataExchangeId, $dataExchangeDisplayName);
}

createListing

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\CreateListingRequest;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Listing;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Listing\BigQueryDatasetSource;

/**
 * @param string $formattedParent    The parent resource path of the listing.
 *                                   e.g. `projects/myproject/locations/US/dataExchanges/123`. Please see
 *                                   {@see AnalyticsHubServiceClient::dataExchangeName()} for help formatting this field.
 * @param string $listingId          The ID of the listing to create.
 *                                   Must contain only Unicode letters, numbers (0-9), underscores (_).
 *                                   Should not use characters that require URL-escaping, or characters
 *                                   outside of ASCII, spaces.
 *                                   Max length: 100 bytes.
 * @param string $listingDisplayName Human-readable display name of the listing. The display name must contain
 *                                   only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces
 *                                   ( ), ampersands (&) and can't start or end with spaces.
 *                                   Default value is an empty string.
 *                                   Max length: 63 bytes.
 */
function create_listing_sample(
    string $formattedParent,
    string $listingId,
    string $listingDisplayName
): void {
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // Prepare the request message.
    $listingBigqueryDataset = new BigQueryDatasetSource();
    $listing = (new Listing())
        ->setBigqueryDataset($listingBigqueryDataset)
        ->setDisplayName($listingDisplayName);
    $request = (new CreateListingRequest())
        ->setParent($formattedParent)
        ->setListingId($listingId)
        ->setListing($listing);

    // Call the API and handle any network failures.
    try {
        /** @var Listing $response */
        $response = $analyticsHubServiceClient->createListing($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 = AnalyticsHubServiceClient::dataExchangeName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]'
    );
    $listingId = '[LISTING_ID]';
    $listingDisplayName = '[DISPLAY_NAME]';

    create_listing_sample($formattedParent, $listingId, $listingDisplayName);
}

deleteDataExchange

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DeleteDataExchangeRequest;

/**
 * @param string $formattedName The full name of the data exchange resource that you want to delete.
 *                              For example, `projects/myproject/locations/US/dataExchanges/123`. Please see
 *                              {@see AnalyticsHubServiceClient::dataExchangeName()} for help formatting this field.
 */
function delete_data_exchange_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $analyticsHubServiceClient->deleteDataExchange($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 = AnalyticsHubServiceClient::dataExchangeName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]'
    );

    delete_data_exchange_sample($formattedName);
}

deleteListing

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DeleteListingRequest;

/**
 * @param string $formattedName Resource name of the listing to delete.
 *                              e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. Please see
 *                              {@see AnalyticsHubServiceClient::listingName()} for help formatting this field.
 */
function delete_listing_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $analyticsHubServiceClient->deleteListing($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 = AnalyticsHubServiceClient::listingName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]',
        '[LISTING]'
    );

    delete_listing_sample($formattedName);
}

getDataExchange

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange;
use Google\Cloud\BigQuery\DataExchange\V1beta1\GetDataExchangeRequest;

/**
 * @param string $formattedName The resource name of the data exchange.
 *                              e.g. `projects/myproject/locations/US/dataExchanges/123`. Please see
 *                              {@see AnalyticsHubServiceClient::dataExchangeName()} for help formatting this field.
 */
function get_data_exchange_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataExchange $response */
        $response = $analyticsHubServiceClient->getDataExchange($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 = AnalyticsHubServiceClient::dataExchangeName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]'
    );

    get_data_exchange_sample($formattedName);
}

getIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
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.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

getListing

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\GetListingRequest;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Listing;

/**
 * @param string $formattedName The resource name of the listing.
 *                              e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. Please see
 *                              {@see AnalyticsHubServiceClient::listingName()} for help formatting this field.
 */
function get_listing_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Listing $response */
        $response = $analyticsHubServiceClient->getListing($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 = AnalyticsHubServiceClient::listingName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]',
        '[LISTING]'
    );

    get_listing_sample($formattedName);
}

listDataExchanges

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange;
use Google\Cloud\BigQuery\DataExchange\V1beta1\ListDataExchangesRequest;

/**
 * @param string $formattedParent The parent resource path of the data exchanges.
 *                                e.g. `projects/myproject/locations/US`. Please see
 *                                {@see AnalyticsHubServiceClient::locationName()} for help formatting this field.
 */
function list_data_exchanges_sample(string $formattedParent): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

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

    list_data_exchanges_sample($formattedParent);
}

listListings

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\ListListingsRequest;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Listing;

/**
 * @param string $formattedParent The parent resource path of the listing.
 *                                e.g. `projects/myproject/locations/US/dataExchanges/123`. Please see
 *                                {@see AnalyticsHubServiceClient::dataExchangeName()} for help formatting this field.
 */
function list_listings_sample(string $formattedParent): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

        /** @var Listing $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 = AnalyticsHubServiceClient::dataExchangeName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]'
    );

    list_listings_sample($formattedParent);
}

listOrgDataExchanges

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange;
use Google\Cloud\BigQuery\DataExchange\V1beta1\ListOrgDataExchangesRequest;

/**
 * @param string $organization The organization resource path of the projects containing DataExchanges.
 *                             e.g. `organizations/myorg/locations/US`.
 */
function list_org_data_exchanges_sample(string $organization): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // Prepare the request message.
    $request = (new ListOrgDataExchangesRequest())
        ->setOrganization($organization);

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

        /** @var DataExchange $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
{
    $organization = '[ORGANIZATION]';

    list_org_data_exchanges_sample($organization);
}

setIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
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.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // 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 = $analyticsHubServiceClient->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);
}

subscribeListing

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\SubscribeListingRequest;
use Google\Cloud\BigQuery\DataExchange\V1beta1\SubscribeListingResponse;

/**
 * @param string $formattedName Resource name of the listing that you want to subscribe to.
 *                              e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. Please see
 *                              {@see AnalyticsHubServiceClient::listingName()} for help formatting this field.
 */
function subscribe_listing_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var SubscribeListingResponse $response */
        $response = $analyticsHubServiceClient->subscribeListing($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 = AnalyticsHubServiceClient::listingName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]',
        '[LISTING]'
    );

    subscribe_listing_sample($formattedName);
}

testIamPermissions

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
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.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // 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 = $analyticsHubServiceClient->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);
}

updateDataExchange

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange;
use Google\Cloud\BigQuery\DataExchange\V1beta1\UpdateDataExchangeRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $dataExchangeDisplayName Human-readable display name of the data exchange. The display name must
 *                                        contain only Unicode letters, numbers (0-9), underscores (_), dashes (-),
 *                                        spaces ( ), ampersands (&) and must not start or end with spaces.
 *                                        Default value is an empty string.
 *                                        Max length: 63 bytes.
 */
function update_data_exchange_sample(string $dataExchangeDisplayName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $dataExchange = (new DataExchange())
        ->setDisplayName($dataExchangeDisplayName);
    $request = (new UpdateDataExchangeRequest())
        ->setUpdateMask($updateMask)
        ->setDataExchange($dataExchange);

    // Call the API and handle any network failures.
    try {
        /** @var DataExchange $response */
        $response = $analyticsHubServiceClient->updateDataExchange($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
{
    $dataExchangeDisplayName = '[DISPLAY_NAME]';

    update_data_exchange_sample($dataExchangeDisplayName);
}

updateListing

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Listing;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Listing\BigQueryDatasetSource;
use Google\Cloud\BigQuery\DataExchange\V1beta1\UpdateListingRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $listingDisplayName Human-readable display name of the listing. The display name must contain
 *                                   only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces
 *                                   ( ), ampersands (&) and can't start or end with spaces.
 *                                   Default value is an empty string.
 *                                   Max length: 63 bytes.
 */
function update_listing_sample(string $listingDisplayName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $listingBigqueryDataset = new BigQueryDatasetSource();
    $listing = (new Listing())
        ->setBigqueryDataset($listingBigqueryDataset)
        ->setDisplayName($listingDisplayName);
    $request = (new UpdateListingRequest())
        ->setUpdateMask($updateMask)
        ->setListing($listing);

    // Call the API and handle any network failures.
    try {
        /** @var Listing $response */
        $response = $analyticsHubServiceClient->updateListing($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
{
    $listingDisplayName = '[DISPLAY_NAME]';

    update_listing_sample($listingDisplayName);
}

getLocation

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
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.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

listLocations

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataExchange\V1beta1\Client\AnalyticsHubServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
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 list_locations_sample(): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

        /** @var Location $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());
    }
}

static::dataExchangeName

static::datasetName

static::listingName

static::locationName

static::parseName

Constants

SERVICE_NAME

Value: 'google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService'

SERVICE_ADDRESS

Value: 'analyticshub.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'