Class DataCatalogClient (0.3.0)

Version 0.3.0

• 3.22.0 (latest)
• 3.21.1
• 3.20.1
• 3.19.1
• 3.18.3
• 3.17.2
• 3.16.0
• 3.15.1
• 3.14.0
• 3.13.1
• 3.12.0
• 3.11.1
• 3.10.0
• 3.9.3
• 3.8.1
• 3.7.1
• 3.6.2
• 3.5.0
• 3.4.3
• 3.3.2
• 3.2.1
• 3.1.1
• 3.0.0
• 2.0.2
• 1.0.2
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0

DataCatalogClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Data Catalog API service allows clients to discover, understand, and manage their data.

Methods

DataCatalogClient

DataCatalogClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
Name	Description
channel	grpc.Channel DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials	google.auth.credentials.Credentials The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config	dict DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.

create_tag

create_tag(parent, tag, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a tag on an Entry.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

parent = client.entry_path('[PROJECT]', '[LOCATION]', '[ENTRY_GROUP]', '[ENTRY]')

TODO: Initialize tag:

tag = {}

response = client.create_tag(parent, tag)

Parameters
Name	Description
parent	str Required. The name of the resource to attach this tag to. Tags can be attached to Entries. (example: "projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}"). Note that this Tag and its child resources may not actually be stored in the location in this name.
tag	Union[dict, Tag] Required. The tag to create. If a dict is provided, it must be of the same form as the protobuf message Tag
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

create_tag_template

create_tag_template(parent, tag_template_id, tag_template, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a tag template.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

parent = client.location_path('[PROJECT]', '[LOCATION]')

TODO: Initialize tag_template_id:

tag_template_id = ''

TODO: Initialize tag_template:

tag_template = {}

response = client.create_tag_template(parent, tag_template_id, tag_template)

Parameters
Name	Description
parent	str Required. The name of the project and the location this template is in. Example: "projects/{project_id}/locations/{location}". Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
tag_template_id	str Required. The id of the tag template to create.
tag_template	Union[dict, TagTemplate] Required. The tag template to create. If a dict is provided, it must be of the same form as the protobuf message TagTemplate
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

create_tag_template_field

create_tag_template_field(parent, tag_template_field_id, tag_template_field, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a field in a tag template.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

parent = client.tag_template_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]')

TODO: Initialize tag_template_field_id:

tag_template_field_id = ''

TODO: Initialize tag_template_field:

tag_template_field = {}

response = client.create_tag_template_field(parent, tag_template_field_id, tag_template_field)

Parameters
Name	Description
parent	str Required. The name of the project this template is in. Example: "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}". Note that this TagTemplateField may not actually be stored in the location in this name.
tag_template_field_id	str Required. The id of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field ids must be at least 1 character long and at most 128 characters long. Field ids must also be unique to their template.
tag_template_field	Union[dict, TagTemplateField] Required. The tag template field to create. If a dict is provided, it must be of the same form as the protobuf message TagTemplateField
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_tag

delete_tag(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a tag.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.tag_path('[PROJECT]', '[LOCATION]', '[ENTRY_GROUP]', '[ENTRY]', '[TAG]')

client.delete_tag(name)

Parameters
Name	Description
name	str Required. The name of the tag to delete. For example, "projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}".
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_tag_template

delete_tag_template(name, force, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a tag template and all tags using the template.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.tag_template_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]')

TODO: Initialize force:

force = False

client.delete_tag_template(name, force)

Parameters
Name	Description
name	str Required. The name of the tag template to delete. For example, "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}".
force	bool Required. Currently, this field must always be set to true. This confirms the deletion of any possible tags using this template. force = false will be supported in the future.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_tag_template_field

delete_tag_template_field(name, force, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a field in a tag template and all uses of that field.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.field_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]', '[FIELD]')

TODO: Initialize force:

force = False

client.delete_tag_template_field(name, force)

Parameters
Name	Description
name	str Required. The name of the tag template field to delete. For example, "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}".
force	bool Required. Currently, this field must always be set to true. This confirms the deletion of this field from any tags using this field. force = false will be supported in the future.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

entry_path

entry_path(project, location, entry_group, entry)

Return a fully-qualified entry string.

field_path

field_path(project, location, tag_template, field)

Return a fully-qualified field string.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
DataCatalogClient	The constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
DataCatalogClient	The constructed client.

get_entry

get_entry(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets an entry.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.entry_path('[PROJECT]', '[LOCATION]', '[ENTRY_GROUP]', '[ENTRY]')

response = client.get_entry(name)

Parameters
Name	Description
name	str Required. The name of the entry. For example, "projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}".
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

get_iam_policy

get_iam_policy(resource, options_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets the access control policy for a resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are:

• Tag templates. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

resource = client.tag_template_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]')

response = client.get_iam_policy(resource)

Parameters
Name	Description
resource	str REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options_	Union[dict, GetPolicyOptions] OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM. If a dict is provided, it must be of the same form as the protobuf message GetPolicyOptions
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

get_tag_template

get_tag_template(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a tag template.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.tag_template_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]')

response = client.get_tag_template(name)

Parameters
Name	Description
name	str Required. The name of the tag template. For example, "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}".
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_tags

list_tags(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists the tags on an Entry.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

parent = client.entry_path('[PROJECT]', '[LOCATION]', '[ENTRY_GROUP]', '[ENTRY]')

Iterate over all results

for element in client.list_tags(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_tags(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
parent	str Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry.
page_size	int The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

location_path

location_path(project, location)

Return a fully-qualified location string.

lookup_entry

lookup_entry(linked_resource=None, sql_resource=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

response = client.lookup_entry()

Parameters
Name	Description
linked_resource	str The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name Full names are case-sensitive. Examples: "//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId". "//pubsub.googleapis.com/projects/projectId/topics/topicId"
sql_resource	str The SQL name of the entry. SQL names are case-sensitive. Examples: .. raw:: html cloud_pubsub.project_id.topic_id pubsub.project_id.topic.id.with.dots bigquery.project_id.dataset_id.table_id datacatalog.project_id.location_id.entry_group_id.entry_id *_ids shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

rename_tag_template_field

rename_tag_template_field(name, new_tag_template_field_id, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Renames a field in a tag template.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.field_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]', '[FIELD]')

TODO: Initialize new_tag_template_field_id:

new_tag_template_field_id = ''

response = client.rename_tag_template_field(name, new_tag_template_field_id)

Parameters
Name	Description
name	str Required. The name of the tag template. For example, "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}".
new_tag_template_field_id	str Required. The new ID of this tag template field. For example, "my_new_field".
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

search_catalog

search_catalog(scope, query, page_size=None, order_by=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Searches Data Catalog for multiple resources like entries, tags that match a query.

This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call Get methods.

Note that searches do not have full recall. There may be results that match your query but are not returned, even in subsequent pages of results. These missing results may vary across repeated calls to search. Do not rely on this method if you need to guarantee full recall.

See Data Catalog Search Syntax <https://cloud.google.com/data-catalog/docs/how-to/search-reference>__ for more information.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

TODO: Initialize scope:

scope = {}

TODO: Initialize query:

query = ''

Iterate over all results

for element in client.search_catalog(scope, query): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.search_catalog(scope, query).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
scope	Union[dict, Scope] Required. The scope of this search request. If a dict is provided, it must be of the same form as the protobuf message Scope
query	str Required. The query string in search query syntax. The query must be non-empty. Query strings can be simple as "x" or more qualified as: - name:x - column:x - description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See Data Catalog Search Syntax https://cloud.google.com/data-catalog/docs/how-to/search-reference__ for more information.
page_size	int The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
order_by	str Specifies the ordering of results, currently supported case-sensitive choices are: .. raw:: html relevance last_access_timestamp [asc|desc], defaults to descending if not specified, last_modified_timestamp [asc|desc], defaults to descending if not specified.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

set_iam_policy

set_iam_policy(resource, policy, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:

• Tag templates. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

resource = client.tag_template_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]')

TODO: Initialize policy:

policy = {}

response = client.set_iam_policy(resource, policy)

Parameters
Name	Description
resource	str REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	Union[dict, Policy] REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. If a dict is provided, it must be of the same form as the protobuf message Policy
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

tag_path

tag_path(project, location, entry_group, entry, tag)

Return a fully-qualified tag string.

tag_template_path

tag_template_path(project, location, tag_template)

Return a fully-qualified tag_template string.

test_iam_permissions

test_iam_permissions(resource, permissions, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resource are:

• tag templates. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

A caller is not required to have Google IAM permission to make this request.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

resource = client.tag_template_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]')

TODO: Initialize permissions:

permissions = []

response = client.test_iam_permissions(resource, permissions)

Parameters
Name	Description
resource	str REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	list[str] 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__.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

update_entry

update_entry(entry, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates an existing entry.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

TODO: Initialize entry:

entry = {}

response = client.update_entry(entry)

Parameters
Name	Description
entry	Union[dict, Entry] Required. The updated Entry. If a dict is provided, it must be of the same form as the protobuf message Entry
update_mask	Union[dict, FieldMask] Optional. The fields to update on the entry. If absent or empty, all modifiable fields are updated. Modifiable fields in synced entries: 1. schema (Pub/Sub topics only) Modifiable fields in native entries: 1. display_name 2. description 3. schema If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

update_tag

update_tag(tag, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates an existing tag.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

TODO: Initialize tag:

tag = {}

response = client.update_tag(tag)

Parameters
Name	Description
tag	Union[dict, Tag] Required. The updated tag. If a dict is provided, it must be of the same form as the protobuf message Tag
update_mask	Union[dict, FieldMask] Optional. The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field fields. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

update_tag_template

update_tag_template(tag_template, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

TODO: Initialize tag_template:

tag_template = {}

response = client.update_tag_template(tag_template)

Parameters
Name	Description
tag_template	Union[dict, TagTemplate] Required. The template to update. If a dict is provided, it must be of the same form as the protobuf message TagTemplate
update_mask	Union[dict, FieldMask] Optional. The field mask specifies the parts of the template to overwrite. Allowed fields: - display_name If update_mask is omitted, all of the allowed fields above will be updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

update_tag_template_field

update_tag_template_field(name, tag_template_field, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates a field in a tag template. This method cannot be used to update the field type.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.DataCatalogClient()

name = client.field_path('[PROJECT]', '[LOCATION]', '[TAG_TEMPLATE]', '[FIELD]')

TODO: Initialize tag_template_field:

tag_template_field = {}

response = client.update_tag_template_field(name, tag_template_field)

Parameters
Name	Description
name	str Required. The name of the tag template field. For example, "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}".
tag_template_field	Union[dict, TagTemplateField] Required. The template to update. If a dict is provided, it must be of the same form as the protobuf message TagTemplateField
update_mask	Union[dict, FieldMask] Optional. The field mask specifies the parts of the template to overwrite. Allowed fields: - display_name - type.enum_type If update_mask is omitted, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will not be retried.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.