As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

google.cloud.bigquery.schema.PolicyTagList

class google.cloud.bigquery.schema.PolicyTagList(names: Iterable[str] = ())[source]

Define Policy Tags for a column.

Parameters

( (names) – Optional[Tuple[str]]): list of policy tags to associate with the column. Policy tag identifiers are of the form projects/*/locations/*/taxonomies/*/policyTags/*.

__init__(names: Iterable[str] = ())[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([names])

Initialize self.

from_api_repr(api_repr)

Return a PolicyTagList object deserialized from a dict.

to_api_repr()

Return a dictionary representing this object.

Attributes

names

Policy tags associated with this definition.

classmethod from_api_repr(api_repr: dict)google.cloud.bigquery.schema.PolicyTagList[source]

Return a PolicyTagList object deserialized from a dict.

This method creates a new PolicyTagList instance that points to the api_repr parameter as its internal properties dict. This means that when a PolicyTagList instance is stored as a property of another object, any changes made at the higher level will also appear here.

Parameters

api_repr (Mapping[str, str]) – The serialized representation of the PolicyTagList, such as what is output by to_api_repr().

Returns

The PolicyTagList object or None.

Return type

Optional[google.cloud.bigquery.schema.PolicyTagList]

property names

Policy tags associated with this definition.

Type

Tuple[str]

to_api_repr()dict[source]

Return a dictionary representing this object.

This method returns the properties dict of the PolicyTagList instance rather than making a copy. This means that when a PolicyTagList instance is stored as a property of another object, any changes made at the higher level will also appear here.

Returns

A dictionary representing the PolicyTagList object in serialized form.

Return type

dict