Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataTaxonomyServiceClient.
Service Description: DataTaxonomyService enables attribute-based governance. The resources currently offered include DataTaxonomy and DataAttribute.
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.
This class is currently experimental and may be subject to changes. See Google\Cloud\Dataplex\V1\DataTaxonomyServiceClient for the stable implementation
Namespace
Google \ Cloud \ Dataplex \ V1 \ ClientMethods
__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. |
createDataAttribute
Create a DataAttribute resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::createDataAttributeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\CreateDataAttributeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\CreateDataAttributeRequest;
use Google\Cloud\Dataplex\V1\DataAttribute;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the parent data taxonomy
* projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
* Please see {@see DataTaxonomyServiceClient::dataTaxonomyName()} for help formatting this field.
* @param string $dataAttributeId DataAttribute identifier.
* * Must contain only lowercase letters, numbers and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* * Must be unique within the DataTaxonomy.
*/
function create_data_attribute_sample(string $formattedParent, string $dataAttributeId): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$dataAttribute = new DataAttribute();
$request = (new CreateDataAttributeRequest())
->setParent($formattedParent)
->setDataAttributeId($dataAttributeId)
->setDataAttribute($dataAttribute);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->createDataAttribute($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataAttribute $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataTaxonomyServiceClient::dataTaxonomyName(
'[PROJECT]',
'[LOCATION]',
'[DATA_TAXONOMY_ID]'
);
$dataAttributeId = '[DATA_ATTRIBUTE_ID]';
create_data_attribute_sample($formattedParent, $dataAttributeId);
}
createDataAttributeBinding
Create a DataAttributeBinding resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::createDataAttributeBindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\CreateDataAttributeBindingRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\CreateDataAttributeBindingRequest;
use Google\Cloud\Dataplex\V1\DataAttributeBinding;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the parent data taxonomy
* projects/{project_number}/locations/{location_id}
* Please see {@see DataTaxonomyServiceClient::locationName()} for help formatting this field.
* @param string $dataAttributeBindingId DataAttributeBinding identifier.
* * Must contain only lowercase letters, numbers and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* * Must be unique within the Location.
*/
function create_data_attribute_binding_sample(
string $formattedParent,
string $dataAttributeBindingId
): void {
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$dataAttributeBinding = new DataAttributeBinding();
$request = (new CreateDataAttributeBindingRequest())
->setParent($formattedParent)
->setDataAttributeBindingId($dataAttributeBindingId)
->setDataAttributeBinding($dataAttributeBinding);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->createDataAttributeBinding($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataAttributeBinding $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataTaxonomyServiceClient::locationName('[PROJECT]', '[LOCATION]');
$dataAttributeBindingId = '[DATA_ATTRIBUTE_BINDING_ID]';
create_data_attribute_binding_sample($formattedParent, $dataAttributeBindingId);
}
createDataTaxonomy
Create a DataTaxonomy resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::createDataTaxonomyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\CreateDataTaxonomyRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\CreateDataTaxonomyRequest;
use Google\Cloud\Dataplex\V1\DataTaxonomy;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the data taxonomy location, of the form:
* projects/{project_number}/locations/{location_id}
* where `location_id` refers to a GCP region. Please see
* {@see DataTaxonomyServiceClient::locationName()} for help formatting this field.
* @param string $dataTaxonomyId DataTaxonomy identifier.
* * Must contain only lowercase letters, numbers and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* * Must be unique within the Project.
*/
function create_data_taxonomy_sample(string $formattedParent, string $dataTaxonomyId): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$dataTaxonomy = new DataTaxonomy();
$request = (new CreateDataTaxonomyRequest())
->setParent($formattedParent)
->setDataTaxonomyId($dataTaxonomyId)
->setDataTaxonomy($dataTaxonomy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->createDataTaxonomy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataTaxonomy $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataTaxonomyServiceClient::locationName('[PROJECT]', '[LOCATION]');
$dataTaxonomyId = '[DATA_TAXONOMY_ID]';
create_data_taxonomy_sample($formattedParent, $dataTaxonomyId);
}
deleteDataAttribute
Deletes a Data Attribute resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::deleteDataAttributeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\DeleteDataAttributeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DeleteDataAttributeRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the DataAttribute:
* projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
* Please see {@see DataTaxonomyServiceClient::dataAttributeName()} for help formatting this field.
*/
function delete_data_attribute_sample(string $formattedName): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new DeleteDataAttributeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->deleteDataAttribute($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 = DataTaxonomyServiceClient::dataAttributeName(
'[PROJECT]',
'[LOCATION]',
'[DATATAXONOMY]',
'[DATA_ATTRIBUTE_ID]'
);
delete_data_attribute_sample($formattedName);
}
deleteDataAttributeBinding
Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::deleteDataAttributeBindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\DeleteDataAttributeBindingRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DeleteDataAttributeBindingRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the DataAttributeBinding:
* projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
* Please see {@see DataTaxonomyServiceClient::dataAttributeBindingName()} for help formatting this field.
* @param string $etag If the client provided etag value does not match the current etag
* value, the DeleteDataAttributeBindingRequest method returns an ABORTED
* error response. Etags must be used when calling the
* DeleteDataAttributeBinding.
*/
function delete_data_attribute_binding_sample(string $formattedName, string $etag): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new DeleteDataAttributeBindingRequest())
->setName($formattedName)
->setEtag($etag);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->deleteDataAttributeBinding($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 = DataTaxonomyServiceClient::dataAttributeBindingName(
'[PROJECT]',
'[LOCATION]',
'[DATA_ATTRIBUTE_BINDING_ID]'
);
$etag = '[ETAG]';
delete_data_attribute_binding_sample($formattedName, $etag);
}
deleteDataTaxonomy
Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::deleteDataTaxonomyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\DeleteDataTaxonomyRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DeleteDataTaxonomyRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the DataTaxonomy:
* projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
* Please see {@see DataTaxonomyServiceClient::dataTaxonomyName()} for help formatting this field.
*/
function delete_data_taxonomy_sample(string $formattedName): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new DeleteDataTaxonomyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->deleteDataTaxonomy($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 = DataTaxonomyServiceClient::dataTaxonomyName(
'[PROJECT]',
'[LOCATION]',
'[DATA_TAXONOMY_ID]'
);
delete_data_taxonomy_sample($formattedName);
}
getDataAttribute
Retrieves a Data Attribute resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::getDataAttributeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\GetDataAttributeRequest
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\Dataplex\V1\DataAttribute |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataAttribute;
use Google\Cloud\Dataplex\V1\GetDataAttributeRequest;
/**
* @param string $formattedName The resource name of the dataAttribute:
* projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
* Please see {@see DataTaxonomyServiceClient::dataAttributeName()} for help formatting this field.
*/
function get_data_attribute_sample(string $formattedName): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new GetDataAttributeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DataAttribute $response */
$response = $dataTaxonomyServiceClient->getDataAttribute($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 = DataTaxonomyServiceClient::dataAttributeName(
'[PROJECT]',
'[LOCATION]',
'[DATATAXONOMY]',
'[DATA_ATTRIBUTE_ID]'
);
get_data_attribute_sample($formattedName);
}
getDataAttributeBinding
Retrieves a DataAttributeBinding resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::getDataAttributeBindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\GetDataAttributeBindingRequest
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\Dataplex\V1\DataAttributeBinding |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataAttributeBinding;
use Google\Cloud\Dataplex\V1\GetDataAttributeBindingRequest;
/**
* @param string $formattedName The resource name of the DataAttributeBinding:
* projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
* Please see {@see DataTaxonomyServiceClient::dataAttributeBindingName()} for help formatting this field.
*/
function get_data_attribute_binding_sample(string $formattedName): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new GetDataAttributeBindingRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DataAttributeBinding $response */
$response = $dataTaxonomyServiceClient->getDataAttributeBinding($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 = DataTaxonomyServiceClient::dataAttributeBindingName(
'[PROJECT]',
'[LOCATION]',
'[DATA_ATTRIBUTE_BINDING_ID]'
);
get_data_attribute_binding_sample($formattedName);
}
getDataTaxonomy
Retrieves a DataTaxonomy resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::getDataTaxonomyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\GetDataTaxonomyRequest
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\Dataplex\V1\DataTaxonomy |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataTaxonomy;
use Google\Cloud\Dataplex\V1\GetDataTaxonomyRequest;
/**
* @param string $formattedName The resource name of the DataTaxonomy:
* projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
* Please see {@see DataTaxonomyServiceClient::dataTaxonomyName()} for help formatting this field.
*/
function get_data_taxonomy_sample(string $formattedName): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new GetDataTaxonomyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DataTaxonomy $response */
$response = $dataTaxonomyServiceClient->getDataTaxonomy($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 = DataTaxonomyServiceClient::dataTaxonomyName(
'[PROJECT]',
'[LOCATION]',
'[DATA_TAXONOMY_ID]'
);
get_data_taxonomy_sample($formattedName);
}
listDataAttributeBindings
Lists DataAttributeBinding resources in a project and location.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::listDataAttributeBindingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\ListDataAttributeBindingsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataAttributeBinding;
use Google\Cloud\Dataplex\V1\ListDataAttributeBindingsRequest;
/**
* @param string $formattedParent The resource name of the Location:
* projects/{project_number}/locations/{location_id}
* Please see {@see DataTaxonomyServiceClient::locationName()} for help formatting this field.
*/
function list_data_attribute_bindings_sample(string $formattedParent): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new ListDataAttributeBindingsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataTaxonomyServiceClient->listDataAttributeBindings($request);
/** @var DataAttributeBinding $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 = DataTaxonomyServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_data_attribute_bindings_sample($formattedParent);
}
listDataAttributes
Lists Data Attribute resources in a DataTaxonomy.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::listDataAttributesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\ListDataAttributesRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataAttribute;
use Google\Cloud\Dataplex\V1\ListDataAttributesRequest;
/**
* @param string $formattedParent The resource name of the DataTaxonomy:
* projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
* Please see {@see DataTaxonomyServiceClient::dataTaxonomyName()} for help formatting this field.
*/
function list_data_attributes_sample(string $formattedParent): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new ListDataAttributesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataTaxonomyServiceClient->listDataAttributes($request);
/** @var DataAttribute $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 = DataTaxonomyServiceClient::dataTaxonomyName(
'[PROJECT]',
'[LOCATION]',
'[DATA_TAXONOMY_ID]'
);
list_data_attributes_sample($formattedParent);
}
listDataTaxonomies
Lists DataTaxonomy resources in a project and location.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::listDataTaxonomiesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\ListDataTaxonomiesRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataTaxonomy;
use Google\Cloud\Dataplex\V1\ListDataTaxonomiesRequest;
/**
* @param string $formattedParent The resource name of the DataTaxonomy location, of the form:
* projects/{project_number}/locations/{location_id}
* where `location_id` refers to a GCP region. Please see
* {@see DataTaxonomyServiceClient::locationName()} for help formatting this field.
*/
function list_data_taxonomies_sample(string $formattedParent): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new ListDataTaxonomiesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataTaxonomyServiceClient->listDataTaxonomies($request);
/** @var DataTaxonomy $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 = DataTaxonomyServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_data_taxonomies_sample($formattedParent);
}
updateDataAttribute
Updates a DataAttribute resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::updateDataAttributeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\UpdateDataAttributeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataAttribute;
use Google\Cloud\Dataplex\V1\UpdateDataAttributeRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* 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 update_data_attribute_sample(): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$updateMask = new FieldMask();
$dataAttribute = new DataAttribute();
$request = (new UpdateDataAttributeRequest())
->setUpdateMask($updateMask)
->setDataAttribute($dataAttribute);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->updateDataAttribute($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataAttribute $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());
}
}
updateDataAttributeBinding
Updates a DataAttributeBinding resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::updateDataAttributeBindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\UpdateDataAttributeBindingRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataAttributeBinding;
use Google\Cloud\Dataplex\V1\UpdateDataAttributeBindingRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* 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 update_data_attribute_binding_sample(): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$updateMask = new FieldMask();
$dataAttributeBinding = new DataAttributeBinding();
$request = (new UpdateDataAttributeBindingRequest())
->setUpdateMask($updateMask)
->setDataAttributeBinding($dataAttributeBinding);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->updateDataAttributeBinding($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataAttributeBinding $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());
}
}
updateDataTaxonomy
Updates a DataTaxonomy resource.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::updateDataTaxonomyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\UpdateDataTaxonomyRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
use Google\Cloud\Dataplex\V1\DataTaxonomy;
use Google\Cloud\Dataplex\V1\UpdateDataTaxonomyRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* 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 update_data_taxonomy_sample(): void
{
// Create a client.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$updateMask = new FieldMask();
$dataTaxonomy = new DataTaxonomy();
$request = (new UpdateDataTaxonomyRequest())
->setUpdateMask($updateMask)
->setDataTaxonomy($dataTaxonomy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataTaxonomyServiceClient->updateDataTaxonomy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataTaxonomy $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());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
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.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataTaxonomyServiceClient->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);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
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.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// 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 = $dataTaxonomyServiceClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
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.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// 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 = $dataTaxonomyServiceClient->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);
}
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::getLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
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.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $dataTaxonomyServiceClient->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.
The async variant is Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient::listLocationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\DataTaxonomyServiceClient;
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.
$dataTaxonomyServiceClient = new DataTaxonomyServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataTaxonomyServiceClient->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());
}
}
createDataAttributeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\CreateDataAttributeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createDataAttributeBindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\CreateDataAttributeBindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createDataTaxonomyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\CreateDataTaxonomyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteDataAttributeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\DeleteDataAttributeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteDataAttributeBindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\DeleteDataAttributeBindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteDataTaxonomyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\DeleteDataTaxonomyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getDataAttributeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\GetDataAttributeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getDataAttributeBindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\GetDataAttributeBindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getDataTaxonomyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\GetDataTaxonomyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDataAttributeBindingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\ListDataAttributeBindingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDataAttributesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\ListDataAttributesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDataTaxonomiesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\ListDataTaxonomiesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateDataAttributeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\UpdateDataAttributeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateDataAttributeBindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\UpdateDataAttributeBindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateDataTaxonomyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataplex\V1\UpdateDataTaxonomyRequest
|
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 |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
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 |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
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::dataAttributeName
Formats a string containing the fully-qualified path to represent a data_attribute resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataTaxonomy |
string
|
dataAttributeId |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted data_attribute resource. |
static::dataAttributeBindingName
Formats a string containing the fully-qualified path to represent a data_attribute_binding resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataAttributeBindingId |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted data_attribute_binding resource. |
static::dataTaxonomyName
Formats a string containing the fully-qualified path to represent a data_taxonomy resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataTaxonomyId |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted data_taxonomy 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
- dataAttribute: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
- dataAttributeBinding: projects/{project}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
- dataTaxonomy: projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}
- 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. |