PolicyTagManagerSerializationAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.datacatalog_v1beta1.services.policy_tag_manager_serialization.transports.base.PolicyTagManagerSerializationTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-datacatalog/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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 clients to manipulate their taxonomies and policy tags data with serialized format.
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: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.datacatalog_v1beta1.services.policy_tag_manager_serialization.transports.base.PolicyTagManagerSerializationTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-datacatalog/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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,
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 |
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[google.cloud.datacatalog_v1beta1.types.policytagmanagerserialization.ExportTaxonomiesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Exports all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls.
Parameters | |
---|---|
Name | Description |
request |
ExportTaxonomiesRequest
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_v1beta1.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_transport_class
get_transport_class()
Returns an appropriate transport class.
import_taxonomies
import_taxonomies(request: Optional[google.cloud.datacatalog_v1beta1.types.policytagmanagerserialization.ImportTaxonomiesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Imports all taxonomies and their policy tags to a project as new taxonomies.
This method provides a bulk taxonomy / policy tag creation using nested proto structure.
Parameters | |
---|---|
Name | Description |
request |
ImportTaxonomiesRequest
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_v1beta1.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.
taxonomy_path
taxonomy_path(project: str, location: str, taxonomy: str)
Returns a fully-qualified taxonomy string.