Class PolicyTagManagerSerializationAsyncClient (3.9.2)

PolicyTagManagerSerializationAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.datacatalog_v1.services.policy_tag_manager_serialization.transports.base.PolicyTagManagerSerializationTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format. Taxonomy is a hierarchical group of policy tags.

Inheritance

builtins.object > PolicyTagManagerSerializationAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
PolicyTagManagerSerializationTransport	The transport used by the client instance.

Methods

PolicyTagManagerSerializationAsyncClient

PolicyTagManagerSerializationAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.datacatalog_v1.services.policy_tag_manager_serialization.transports.base.PolicyTagManagerSerializationTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the policy tag manager serialization client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, `.PolicyTagManagerSerializationTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

export_taxonomies

export_taxonomies(request: Optional[Union[google.cloud.datacatalog_v1.types.policytagmanagerserialization.ExportTaxonomiesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

# 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_export_taxonomies():
    # Create a client
    client = datacatalog_v1.PolicyTagManagerSerializationAsyncClient()

    # Initialize request argument(s)
    request = datacatalog_v1.ExportTaxonomiesRequest(
        serialized_taxonomies=True,
        parent="parent_value",
        taxonomies=['taxonomies_value1', 'taxonomies_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.datacatalog_v1.types.ExportTaxonomiesRequest, dict]` The request object. Request message for ExportTaxonomies.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.datacatalog_v1.types.ExportTaxonomiesResponse	Response message for ExportTaxonomies.

from_service_account_file

from_service_account_file(filename: str, *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
PolicyTagManagerSerializationAsyncClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
PolicyTagManagerSerializationAsyncClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *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
PolicyTagManagerSerializationAsyncClient	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

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.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

import_taxonomies

import_taxonomies(request: Optional[Union[google.cloud.datacatalog_v1.types.policytagmanagerserialization.ImportTaxonomiesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

# 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_import_taxonomies():
    # Create a client
    client = datacatalog_v1.PolicyTagManagerSerializationAsyncClient()

    # Initialize request argument(s)
    inline_source = datacatalog_v1.InlineSource()
    inline_source.taxonomies.display_name = "display_name_value"

    request = datacatalog_v1.ImportTaxonomiesRequest(
        inline_source=inline_source,
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.datacatalog_v1.types.ImportTaxonomiesRequest, dict]` The request object. Request message for ImportTaxonomies.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.datacatalog_v1.types.ImportTaxonomiesResponse	Response message for ImportTaxonomies.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_taxonomy_path

parse_taxonomy_path(path: str)

Parses a taxonomy path into its component segments.

replace_taxonomy

replace_taxonomy(request: Optional[Union[google.cloud.datacatalog_v1.types.policytagmanagerserialization.ReplaceTaxonomyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

Deletes the existing policy tags that are missing from the SerializedPolicyTag.
Creates policy tags that don't have resource names. They are considered new.
Updates policy tags with valid resources names accordingly.

# 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_replace_taxonomy():
    # Create a client
    client = datacatalog_v1.PolicyTagManagerSerializationAsyncClient()

    # Initialize request argument(s)
    serialized_taxonomy = datacatalog_v1.SerializedTaxonomy()
    serialized_taxonomy.display_name = "display_name_value"

    request = datacatalog_v1.ReplaceTaxonomyRequest(
        name="name_value",
        serialized_taxonomy=serialized_taxonomy,
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.datacatalog_v1.types.ReplaceTaxonomyRequest, dict]` The request object. Request message for ReplaceTaxonomy.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type

Description

google.cloud.datacatalog_v1.types.Taxonomy

A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: :literal:`\` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue`\ \` A "data origin" taxonomy might contain the following policy tags: :literal:`\` + User data + Employee data + Partner data + Public data`\ \`

taxonomy_path

taxonomy_path(project: str, location: str, taxonomy: str)

Returns a fully-qualified taxonomy string.