Class PolicyTagManagerSerializationClient (0.7.0)

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

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

Methods

PolicyTagManagerSerializationClient

PolicyTagManagerSerializationClient(
    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.

export_taxonomies

export_taxonomies(parent=None, taxonomies=None, serialized_taxonomies=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.PolicyTagManagerSerializationClient()

response = client.export_taxonomies()

Parameters
Name	Description
`parent`	`str` Required. Resource name of the project that taxonomies to be exported will share.
`taxonomies`	`list[str]` Required. Resource names of the taxonomies to be exported.
`serialized_taxonomies`	`bool` Export taxonomies as serialized taxonomies.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`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.

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
`PolicyTagManagerSerializationClient`	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
`PolicyTagManagerSerializationClient`	The constructed client.

import_taxonomies

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

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.

.. rubric:: Example

from google.cloud import datacatalog_v1beta1

client = datacatalog_v1beta1.PolicyTagManagerSerializationClient()

response = client.import_taxonomies()

Parameters
Name	Description
`parent`	`str` Required. Resource name of project that the newly created taxonomies will belong to.
`inline_source`	`Union[dict, InlineSource]` Inline source used for taxonomies import If a dict is provided, it must be of the same form as the protobuf message InlineSource
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`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.