Google Cloud BigQuery Analytics Hub V1 Client - Class AnalyticsHubServiceClient (0.4.0)

Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class AnalyticsHubServiceClient.

Service Description: The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish listings that reference shared datasets. With Analytics Hub, users can discover and search for listings that they have access to. Subscribers can view and subscribe to listings. When you subscribe to a listing, Analytics Hub creates a linked dataset in your project.

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 \ BigQuery \ AnalyticsHub \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` 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`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ 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.

createDataExchange

Creates a new data exchange.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::createDataExchangeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\CreateDataExchangeRequest` 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\BigQuery\AnalyticsHub\V1\DataExchange`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\CreateDataExchangeRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Creates a new listing.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::createListingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\CreateListingRequest` 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\BigQuery\AnalyticsHub\V1\Listing`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\CreateListingRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Listing;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Deletes an existing data exchange.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::deleteDataExchangeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteDataExchangeRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Deletes a listing.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::deleteListingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteListingRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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);
}

deleteSubscription

Deletes a subscription.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::deleteSubscriptionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteSubscriptionRequest` 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\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteSubscriptionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Resource name of the subscription to delete.
 *                              e.g. projects/123/locations/US/subscriptions/456
 *                              Please see {@see AnalyticsHubServiceClient::subscriptionName()} for help formatting this field.
 */
function delete_subscription_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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
{
    $formattedName = AnalyticsHubServiceClient::subscriptionName(
        '[PROJECT]',
        '[LOCATION]',
        '[SUBSCRIPTION]'
    );

    delete_subscription_sample($formattedName);
}

getDataExchange

Gets the details of a data exchange.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::getDataExchangeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\GetDataExchangeRequest` 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\BigQuery\AnalyticsHub\V1\DataExchange`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\DataExchange;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Gets the IAM policy.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` 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\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Gets the details of a listing.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::getListingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\GetListingRequest` 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\BigQuery\AnalyticsHub\V1\Listing`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\GetListingRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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);
}

getSubscription

Gets the details of a Subscription.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::getSubscriptionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\GetSubscriptionRequest` 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\BigQuery\AnalyticsHub\V1\Subscription`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\GetSubscriptionRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Subscription;

/**
 * @param string $formattedName Resource name of the subscription.
 *                              e.g. projects/123/locations/US/subscriptions/456
 *                              Please see {@see AnalyticsHubServiceClient::subscriptionName()} for help formatting this field.
 */
function get_subscription_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

    get_subscription_sample($formattedName);
}

listDataExchanges

Lists all data exchanges in a given project and location.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::listDataExchangesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListDataExchangesRequest` 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\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\DataExchange;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Lists all listings in a given project and location.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::listListingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListListingsRequest` 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\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\ListListingsRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Lists all data exchanges from projects in a given organization and location.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::listOrgDataExchangesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListOrgDataExchangesRequest` 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\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\DataExchange;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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);
}

listSharedResourceSubscriptions

Lists all subscriptions on a given Data Exchange or Listing.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::listSharedResourceSubscriptionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListSharedResourceSubscriptionsRequest` 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\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\ListSharedResourceSubscriptionsRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Subscription;

/**
 * @param string $resource Resource name of the requested target. This resource may be
 *                         either a Listing or a DataExchange. e.g.
 *                         projects/123/locations/US/dataExchanges/456 OR e.g.
 *                         projects/123/locations/US/dataExchanges/456/listings/789
 */
function list_shared_resource_subscriptions_sample(string $resource): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

        /** @var Subscription $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
{
    $resource = '[RESOURCE]';

    list_shared_resource_subscriptions_sample($resource);
}

listSubscriptions

Lists all subscriptions in a given project and location.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::listSubscriptionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListSubscriptionsRequest` 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\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\ListSubscriptionsRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Subscription;

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

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

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

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

refreshSubscription

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::refreshSubscriptionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\RefreshSubscriptionRequest` 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\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\RefreshSubscriptionRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\RefreshSubscriptionResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName Resource name of the Subscription to refresh.
 *                              e.g. `projects/subscriberproject/locations/US/subscriptions/123`
 *                              Please see {@see AnalyticsHubServiceClient::subscriptionName()} for help formatting this field.
 */
function refresh_subscription_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var RefreshSubscriptionResponse $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
{
    $formattedName = AnalyticsHubServiceClient::subscriptionName(
        '[PROJECT]',
        '[LOCATION]',
        '[SUBSCRIPTION]'
    );

    refresh_subscription_sample($formattedName);
}

revokeSubscription

Revokes a given subscription.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::revokeSubscriptionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\RevokeSubscriptionRequest` 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\BigQuery\AnalyticsHub\V1\RevokeSubscriptionResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\RevokeSubscriptionRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\RevokeSubscriptionResponse;

/**
 * @param string $formattedName Resource name of the subscription to revoke.
 *                              e.g. projects/123/locations/US/subscriptions/456
 *                              Please see {@see AnalyticsHubServiceClient::subscriptionName()} for help formatting this field.
 */
function revoke_subscription_sample(string $formattedName): void
{
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

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

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

    revoke_subscription_sample($formattedName);
}

setIamPolicy

Sets the IAM policy.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` 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\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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);
}

subscribeDataExchange

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::subscribeDataExchangeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeDataExchangeRequest` 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\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeDataExchangeRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeDataExchangeResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName        Resource name of the Data Exchange.
 *                                     e.g. `projects/publisherproject/locations/US/dataExchanges/123`
 *                                     Please see {@see AnalyticsHubServiceClient::dataExchangeName()} for help formatting this field.
 * @param string $formattedDestination The parent resource path of the Subscription.
 *                                     e.g. `projects/subscriberproject/locations/US`
 *                                     Please see {@see AnalyticsHubServiceClient::locationName()} for help formatting this field.
 * @param string $subscription         Name of the subscription to create.
 *                                     e.g. `subscription1`
 */
function subscribe_data_exchange_sample(
    string $formattedName,
    string $formattedDestination,
    string $subscription
): void {
    // Create a client.
    $analyticsHubServiceClient = new AnalyticsHubServiceClient();

    // Prepare the request message.
    $request = (new SubscribeDataExchangeRequest())
        ->setName($formattedName)
        ->setDestination($formattedDestination)
        ->setSubscription($subscription);

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

        if ($response->operationSucceeded()) {
            /** @var SubscribeDataExchangeResponse $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
{
    $formattedName = AnalyticsHubServiceClient::dataExchangeName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_EXCHANGE]'
    );
    $formattedDestination = AnalyticsHubServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $subscription = '[SUBSCRIPTION]';

    subscribe_data_exchange_sample($formattedName, $formattedDestination, $subscription);
}

subscribeListing

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::subscribeListingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeListingRequest` 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\BigQuery\AnalyticsHub\V1\SubscribeListingResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeListingRequest;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Returns the permissions that a caller has.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` 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\Iam\V1\TestIamPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Updates an existing data exchange.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::updateDataExchangeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\UpdateDataExchangeRequest` 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\BigQuery\AnalyticsHub\V1\DataExchange`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\DataExchange;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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

Updates an existing listing.

The async variant is Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient::updateListingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\UpdateListingRequest` 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\BigQuery\AnalyticsHub\V1\Listing`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Client\AnalyticsHubServiceClient;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Listing;
use Google\Cloud\BigQuery\AnalyticsHub\V1\Listing\BigQueryDatasetSource;
use Google\Cloud\BigQuery\AnalyticsHub\V1\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);
}

createDataExchangeAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\CreateDataExchangeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createListingAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\CreateListingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDataExchangeAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteDataExchangeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteListingAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteListingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSubscriptionAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\DeleteSubscriptionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDataExchangeAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\GetDataExchangeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getListingAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\GetListingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSubscriptionAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\GetSubscriptionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDataExchangesAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListDataExchangesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listListingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListListingsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listOrgDataExchangesAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListOrgDataExchangesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSharedResourceSubscriptionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListSharedResourceSubscriptionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSubscriptionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\ListSubscriptionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

refreshSubscriptionAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\RefreshSubscriptionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

revokeSubscriptionAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\RevokeSubscriptionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

subscribeDataExchangeAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeDataExchangeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

subscribeListingAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\SubscribeListingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDataExchangeAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\UpdateDataExchangeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateListingAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\AnalyticsHub\V1\UpdateListingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::dataExchangeName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataExchange`	`string`

Returns
Type	Description
`string`	The formatted data_exchange resource.

static::datasetName

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

Parameters
Name	Description
`project`	`string`
`dataset`	`string`

Returns
Type	Description
`string`	The formatted dataset resource.

static::listingName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataExchange`	`string`
`listing`	`string`

Returns
Type	Description
`string`	The formatted listing resource.

static::locationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::subscriptionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`subscription`	`string`

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

dataExchange: projects/{project}/locations/{location}/dataExchanges/{data_exchange}
dataset: projects/{project}/datasets/{dataset}
listing: projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}
location: projects/{project}/locations/{location}
subscription: projects/{project}/locations/{location}/subscriptions/{subscription}

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.