Class PolicyTagManagerSerializationClient (2.0.2)

PolicyTagManagerSerializationClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.datacatalog_v1beta1.services.policy_tag_manager_serialization.transports.base.PolicyTagManagerSerializationTransport] = None, 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)

Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.

Methods

PolicyTagManagerSerializationClient

PolicyTagManagerSerializationClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.datacatalog_v1beta1.services.policy_tag_manager_serialization.transports.base.PolicyTagManagerSerializationTransport] = None, 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)

Instantiate 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 environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

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`	`.policytagmanagerserialization.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
`.policytagmanagerserialization.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
`{@api.name}`	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
`{@api.name}`	The constructed client.

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`	`.policytagmanagerserialization.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
`.policytagmanagerserialization.ImportTaxonomiesResponse`	Response message for ImportTaxonomies.