Class DataCatalogAsyncClient (3.9.3)

Data Catalog API service allows you to discover, understand, and manage your data.

Returns the transport used by the client instance.

Instantiates the data catalog client.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

An entry group can have a maximum of 100,000 entries.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_create_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    entry = datacatalog_v1.Entry()
    entry.type_ = "SERVICE"
    entry.integrated_system = "DATAPLEX"
    entry.gcs_fileset_spec.file_patterns = ['file_patterns_value1', 'file_patterns_value2']

    request = datacatalog_v1.CreateEntryRequest(
        parent="parent_value",
        entry_id="entry_id_value",
        entry=entry,
    )

    # Make the request
    response = await client.create_entry(request=request)

    # Handle the response
    print(response)

Creates an entry group.

An entry group contains logically related entries together with Cloud Identity and Access Management </data-catalog/docs/concepts/iam>__ policies. These policies specify users who can create, edit, and view entries within entry groups.

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

• BigQuery entries (@bigquery)
• Pub/Sub topics (@pubsub)
• Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups.

Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_create_entry_group():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.CreateEntryGroupRequest(
        parent="parent_value",
        entry_group_id="entry_group_id_value",
    )

    # Make the request
    response = await client.create_entry_group(request=request)

    # Handle the response
    print(response)

Creates a tag and assigns it to:

• An xref_Entry if the method name is projects.locations.entryGroups.entries.tags.create.
• Or xref_EntryGroupif the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_create_tag():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    tag = datacatalog_v1.Tag()
    tag.column = "column_value"
    tag.template = "template_value"

    request = datacatalog_v1.CreateTagRequest(
        parent="parent_value",
        tag=tag,
    )

    # Make the request
    response = await client.create_tag(request=request)

    # Handle the response
    print(response)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_create_tag_template():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.CreateTagTemplateRequest(
        parent="parent_value",
        tag_template_id="tag_template_id_value",
    )

    # Make the request
    response = await client.create_tag_template(request=request)

    # Handle the response
    print(response)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_create_tag_template_field():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    tag_template_field = datacatalog_v1.TagTemplateField()
    tag_template_field.type_.primitive_type = "RICHTEXT"

    request = datacatalog_v1.CreateTagTemplateFieldRequest(
        parent="parent_value",
        tag_template_field_id="tag_template_field_id_value",
        tag_template_field=tag_template_field,
    )

    # Make the request
    response = await client.create_tag_template_field(request=request)

    # Handle the response
    print(response)

Deletes an existing entry.

You can delete only the entries created by the xref_CreateEntry method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_delete_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.DeleteEntryRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_entry(request=request)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_delete_entry_group():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.DeleteEntryGroupRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_entry_group(request=request)

Deletes a tag.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_delete_tag():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.DeleteTagRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_tag(request=request)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_delete_tag_template():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.DeleteTagTemplateRequest(
        name="name_value",
        force=True,
    )

    # Make the request
    await client.delete_tag_template(request=request)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_delete_tag_template_field():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.DeleteTagTemplateFieldRequest(
        name="name_value",
        force=True,
    )

    # Make the request
    await client.delete_tag_template_field(request=request)

Returns a fully-qualified entry_group string.

Returns a fully-qualified entry string.

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

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

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

Gets an entry.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_get_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.GetEntryRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_entry(request=request)

    # Handle the response
    print(response)

Gets an entry group.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_get_entry_group():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.GetEntryGroupRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_entry_group(request=request)

    # Handle the response
    print(response)

Gets the access control policy for a resource.

May return:

• A\ NOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
• An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

• Tag templates
• Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

• datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
• datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_get_iam_policy():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets a tag template.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_get_tag_template():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.GetTagTemplateRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_tag_template(request=request)

    # Handle the response
    print(response)

Returns an appropriate transport class.

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use xref_SearchCatalog.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_list_entries():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.ListEntriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entries(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists entry groups.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_list_entry_groups():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.ListEntryGroupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entry_groups(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists tags assigned to an xref_Entry. The xref_columns in the response are lowercased.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_list_tags():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.ListTagsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_tags(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_lookup_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.LookupEntryRequest(
        linked_resource="linked_resource_value",
    )

    # Make the request
    response = await client.lookup_entry(request=request)

    # Handle the response
    print(response)

Modifies contacts, part of the business context of an xref_Entry.

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_modify_entry_contacts():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.ModifyEntryContactsRequest(
        name="name_value",
    )

    # Make the request
    response = await client.modify_entry_contacts(request=request)

    # Handle the response
    print(response)

Modifies entry overview, part of the business context of an xref_Entry.

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_modify_entry_overview():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.ModifyEntryOverviewRequest(
        name="name_value",
    )

    # Make the request
    response = await client.modify_entry_overview(request=request)

    # Handle the response
    print(response)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a entry_group path into its component segments.

Parses a entry path into its component segments.

Parses a tag path into its component segments.

Parses a tag_template_field_enum_value path into its component segments.

Parses a tag_template_field path into its component segments.

Parses a tag_template path into its component segments.

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_rename_tag_template_field():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.RenameTagTemplateFieldRequest(
        name="name_value",
        new_tag_template_field_id="new_tag_template_field_id_value",
    )

    # Make the request
    response = await client.rename_tag_template_field(request=request)

    # Handle the response
    print(response)

Renames an enum value in a tag template. Within a single enum field, enum values must be unique.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_rename_tag_template_field_enum_value():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.RenameTagTemplateFieldEnumValueRequest(
        name="name_value",
        new_enum_value_display_name="new_enum_value_display_name_value",
    )

    # Make the request
    response = await client.rename_tag_template_field_enum_value(request=request)

    # Handle the response
    print(response)

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

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.

For more information, see Data Catalog search syntax.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_search_catalog():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.SearchCatalogRequest(
    )

    # Make the request
    page_result = client.search_catalog(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are:

• Tag templates
• Entry groups

Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.

To call this method, you must have the following Google IAM permissions:

• datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
• datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_set_iam_policy():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Marks an xref_Entry as starred by the current user. Starring information is private to each user.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_star_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.StarEntryRequest(
        name="name_value",
    )

    # Make the request
    response = await client.star_entry(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified tag string.

Returns a fully-qualified tag_template_field_enum_value string.

Returns a fully-qualified tag_template_field string.

Returns a fully-qualified tag_template string.

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are:

• Tag templates
• Entry groups

Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_test_iam_permissions():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = await client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Marks an xref_Entry as NOT starred by the current user. Starring information is private to each user.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_unstar_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.UnstarEntryRequest(
        name="name_value",
    )

    # Make the request
    response = await client.unstar_entry(request=request)

    # Handle the response
    print(response)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_update_entry():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    entry = datacatalog_v1.Entry()
    entry.type_ = "SERVICE"
    entry.integrated_system = "DATAPLEX"
    entry.gcs_fileset_spec.file_patterns = ['file_patterns_value1', 'file_patterns_value2']

    request = datacatalog_v1.UpdateEntryRequest(
        entry=entry,
    )

    # Make the request
    response = await client.update_entry(request=request)

    # Handle the response
    print(response)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_update_entry_group():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.UpdateEntryGroupRequest(
    )

    # Make the request
    response = await client.update_entry_group(request=request)

    # Handle the response
    print(response)

Updates an existing tag.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_update_tag():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    tag = datacatalog_v1.Tag()
    tag.column = "column_value"
    tag.template = "template_value"

    request = datacatalog_v1.UpdateTagRequest(
        tag=tag,
    )

    # Make the request
    response = await client.update_tag(request=request)

    # Handle the response
    print(response)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_update_tag_template():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.UpdateTagTemplateRequest(
    )

    # Make the request
    response = await client.update_tag_template(request=request)

    # Handle the response
    print(response)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1

async def sample_update_tag_template_field():
    # Create a client
    client = datacatalog_v1.DataCatalogAsyncClient()

    # Initialize request argument(s)
    tag_template_field = datacatalog_v1.TagTemplateField()
    tag_template_field.type_.primitive_type = "RICHTEXT"

    request = datacatalog_v1.UpdateTagTemplateFieldRequest(
        name="name_value",
        tag_template_field=tag_template_field,
    )

    # Make the request
    response = await client.update_tag_template_field(request=request)

    # Handle the response
    print(response)