Google Cloud Data Catalog V1 Client - Class SerializedTaxonomy (1.10.1)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class SerializedTaxonomy.

A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.

Generated from protobuf message google.cloud.datacatalog.v1.SerializedTaxonomy

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ display_name string

Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.

↳ description string

Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.

↳ policy_tags array<Google\Cloud\DataCatalog\V1\SerializedPolicyTag>

Top level policy tags associated with the taxonomy, if any.

↳ activated_policy_types array

A list of policy types that are activated per taxonomy.

getDisplayName

Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.

Returns
Type Description
string

setDisplayName

Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.

Returns
Type Description
string

setDescription

Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.

Parameter
Name Description
var string
Returns
Type Description
$this

getPolicyTags

Top level policy tags associated with the taxonomy, if any.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPolicyTags

Top level policy tags associated with the taxonomy, if any.

Parameter
Name Description
var array<Google\Cloud\DataCatalog\V1\SerializedPolicyTag>
Returns
Type Description
$this

getActivatedPolicyTypes

A list of policy types that are activated per taxonomy.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setActivatedPolicyTypes

A list of policy types that are activated per taxonomy.

Parameter
Name Description
var int[]
Returns
Type Description
$this