Reference documentation and code samples for the Google Cloud BigQuery Data Exchange V1beta1 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. Sample code to get started:
$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();
}
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 \ DataExchange \ V1beta1Methods
__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 |
↳ 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 |
↳ 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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource path of the data exchange.
e.g. |
dataExchangeId |
string
Required. 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. |
dataExchange |
Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange
Required. The data exchange to create. |
optionalArgs |
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\DataExchange\V1beta1\DataExchange |
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
Creates a new listing.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource path of the listing.
e.g. |
listingId |
string
Required. 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. |
listing |
Google\Cloud\BigQuery\DataExchange\V1beta1\Listing
Required. The listing to create. |
optionalArgs |
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\DataExchange\V1beta1\Listing |
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
Deletes an existing data exchange.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The full name of the data exchange resource that you want to delete.
For example, |
optionalArgs |
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. |
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
Deletes a listing.
Parameters | |
---|---|
Name | Description |
name |
string
Required. Resource name of the listing to delete.
e.g. |
optionalArgs |
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. |
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
Gets the details of a data exchange.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the data exchange.
e.g. |
optionalArgs |
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\DataExchange\V1beta1\DataExchange |
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
Gets the IAM policy.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ 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 |
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
Gets the details of a listing.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the listing.
e.g. |
optionalArgs |
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\DataExchange\V1beta1\Listing |
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
Lists all data exchanges in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource path of the data exchanges.
e.g. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
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
Lists all listings in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource path of the listing.
e.g. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
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
Lists all data exchanges from projects in a given organization and location.
Parameters | |
---|---|
Name | Description |
organization |
string
Required. The organization resource path of the projects containing DataExchanges.
e.g. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
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
Sets the IAM policy.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ 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 |
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
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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. Resource name of the listing that you want to subscribe to.
e.g. |
optionalArgs |
array
Optional. |
↳ destinationDataset |
DestinationDataset
BigQuery destination dataset to create for the subscriber. |
↳ 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\DataExchange\V1beta1\SubscribeListingResponse |
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
Returns the permissions that a caller has.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
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 |
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
Updates an existing data exchange.
Parameters | |
---|---|
Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Field mask specifies the fields to update in the data exchange
resource. The fields specified in the
|
dataExchange |
Google\Cloud\BigQuery\DataExchange\V1beta1\DataExchange
Required. The data exchange to update. |
optionalArgs |
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\DataExchange\V1beta1\DataExchange |
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
Updates an existing listing.
Parameters | |
---|---|
Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Field mask specifies the fields to update in the listing resource. The
fields specified in the |
listing |
Google\Cloud\BigQuery\DataExchange\V1beta1\Listing
Required. The listing to update. |
optionalArgs |
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\DataExchange\V1beta1\Listing |
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
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ 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\Location\Location |
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
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
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
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::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}
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. |
Constants
SERVICE_NAME
Value: 'google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService'
The name of the service.
SERVICE_ADDRESS
Value: 'analyticshub.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.