Google Cloud Dataplex V1 Client - Class MetadataServiceClient (0.1.6)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class MetadataServiceClient.

Service Description: Metadata service manages metadata resources such as tables, filesets and partitions.

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:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedParent = $metadataServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
    $entity = new Entity();
    $response = $metadataServiceClient->createEntity($formattedParent, $entity);
} finally {
    $metadataServiceClient->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.

Methods

entityName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`entity`	`string`

Returns
Type	Description
`string`	The formatted entity resource.

partitionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`entity`	`string`
`partition`	`string`

Returns
Type	Description
`string`	The formatted partition resource.

zoneName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`

Returns
Type	Description
`string`	The formatted zone resource.

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

entity: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}
partition: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition}
zone: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}

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.

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ serviceAddress`	`string` Deprecated. This option will be removed in a future major release. Please utilize the `$apiEndpoint` option instead.
`↳ 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 {@see} object or {@see} 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 {@see} .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated {@see} object. Note that when this object is provided, any settings in $transportConfig, and any $serviceAddress setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the {@see} and {@see} 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.

createEntity

Create a metadata entity.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedParent = $metadataServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
    $entity = new Entity();
    $response = $metadataServiceClient->createEntity($formattedParent, $entity);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
`entity`	`Google\Cloud\Dataplex\V1\Entity` Required. Entity resource.
`optionalArgs`	`array` Optional.
`↳ validateOnly`	`bool` Optional. Only validate the request, but do not perform mutations. The default is false.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Entity`

createPartition

Create a metadata partition.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedParent = $metadataServiceClient->entityName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ENTITY]');
    $partition = new Partition();
    $response = $metadataServiceClient->createPartition($formattedParent, $partition);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
`partition`	`Google\Cloud\Dataplex\V1\Partition` Required. Partition resource.
`optionalArgs`	`array` Optional.
`↳ validateOnly`	`bool` Optional. Only validate the request, but do not perform mutations. The default is false.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Partition`

deleteEntity

Delete a metadata entity.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedName = $metadataServiceClient->entityName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ENTITY]');
    $etag = 'etag';
    $metadataServiceClient->deleteEntity($formattedName, $etag);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`name`	`string` Required. The resource name of the entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
`etag`	`string` Required. The etag associated with the partition if it was previously retrieved.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

deletePartition

Delete a metadata partition.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedName = $metadataServiceClient->partitionName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ENTITY]', '[PARTITION]');
    $metadataServiceClient->deletePartition($formattedName);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`name`	`string` Required. The resource name of the partition. format: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}`. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.
`optionalArgs`	`array` Optional.
`↳ etag`	`string` Optional. The etag associated with the partition if it was previously retrieved.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

getEntity

Get a metadata entity.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedName = $metadataServiceClient->entityName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ENTITY]');
    $response = $metadataServiceClient->getEntity($formattedName);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`name`	`string` Required. The resource name of the entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.`
`optionalArgs`	`array` Optional.
`↳ view`	`int` Optional. Used to select the subset of entity information to return. Defaults to `BASIC`. For allowed values, use constants defined on {@see}
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Entity`

getPartition

Get a metadata partition of an entity.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedName = $metadataServiceClient->partitionName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ENTITY]', '[PARTITION]');
    $response = $metadataServiceClient->getPartition($formattedName);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`name`	`string` Required. The resource name of the partition: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}`. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Partition`

listEntities

List metadata entities in a zone.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedParent = $metadataServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
    $view = EntityView::ENTITY_VIEW_UNSPECIFIED;
    // Iterate over pages of elements
    $pagedResponse = $metadataServiceClient->listEntities($formattedParent, $view);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $metadataServiceClient->listEntities($formattedParent, $view);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
`view`	`int` Required. Specify the entity view to make a partial list request. For allowed values, use constants defined on {@see}
`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.
`↳ filter`	`string` Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: - Entity ID: ?filter="id=entityID" - Asset ID: ?filter="asset=assetID" - Data path ?filter="data_path=gs://my-bucket" - Is HIVE compatible: ?filter=”hive_compatible=true” - Is BigQuery compatible: ?filter=”bigquery_compatible=true”
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listPartitions

List metadata partitions of an entity.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $formattedParent = $metadataServiceClient->entityName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ENTITY]');
    // Iterate over pages of elements
    $pagedResponse = $metadataServiceClient->listPartitions($formattedParent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $metadataServiceClient->listPartitions($formattedParent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. The resource name of the parent entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
`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.
`↳ filter`	`string` Optional. Filter the partitions returned to the caller using a key vslue pair expression. The filter expression supports: - logical operators: AND, OR - comparison operators: <, >, >=, <= ,=, != - LIKE operators: - The right hand of a LIKE operator supports “.” and “” for wildcard searches, for example "value1 LIKE ".oo." - parenthetical grouping: ( ) Sample filter expression: `?filter="key1 < value1 OR key2 > value2" *Notes: - Keys to the left of operators are case insensitive. - Partition results are sorted first by creation time, then by lexicographic order. - Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateEntity

Update a metadata entity. Only supports full resource update.

Sample code:

$metadataServiceClient = new MetadataServiceClient();
try {
    $entity = new Entity();
    $response = $metadataServiceClient->updateEntity($entity);
} finally {
    $metadataServiceClient->close();
}

Parameters
Name	Description
`entity`	`Google\Cloud\Dataplex\V1\Entity` Required. Update description.
`optionalArgs`	`array` Optional.
`↳ validateOnly`	`bool` Optional. Only validate the request, but do not perform mutations. The default is false.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Entity`

Constants

SERVICE_NAME

Value: 'google.cloud.dataplex.v1.MetadataService'

The name of the service.

SERVICE_ADDRESS

Value: 'dataplex.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.