class ProjectsLocationsTaxonomies extends Resource (View source)

The "taxonomies" collection of methods.

Typical usage is:

 $datacatalogService = new Google\Service\DataCatalog(...);
 $taxonomies = $datacatalogService->projects_locations_taxonomies;

Methods

create(string $parent, GoogleCloudDatacatalogV1Taxonomy $postBody, array $optParams = [])

Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags. (taxonomies.create)

delete(string $name, array $optParams = [])

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

export(string $parent, array $optParams = [])

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

get(string $name, array $optParams = [])

Gets a taxonomy. (taxonomies.get)

getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the IAM policy for a policy tag or a taxonomy. (taxonomies.getIamPolicy)

import(string $parent, GoogleCloudDatacatalogV1ImportTaxonomiesRequest $postBody, array $optParams = [])

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures. (taxonomies.import)

listProjectsLocationsTaxonomies(string $parent, array $optParams = [])

Lists all taxonomies in a project in a particular location that you have a permission to view. (taxonomies.listProjectsLocationsTaxonomies)

patch(string $name, GoogleCloudDatacatalogV1Taxonomy $postBody, array $optParams = [])

Updates a taxonomy, including its display name, description, and activated policy types. (taxonomies.patch)

replace(string $name, GoogleCloudDatacatalogV1ReplaceTaxonomyRequest $postBody, array $optParams = [])

Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the SerializedPolicyTag. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly. (taxonomies.replace)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the IAM policy for a policy tag or a taxonomy. (taxonomies.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns your permissions on a specified policy tag or taxonomy.

Details

GoogleCloudDatacatalogV1Taxonomy create(string $parent, GoogleCloudDatacatalogV1Taxonomy $postBody, array $optParams = [])

Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags. (taxonomies.create)

Parameters

string $parent

Required. Resource name of the project that the taxonomy will belong to.

GoogleCloudDatacatalogV1Taxonomy $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Taxonomy

Exceptions

Exception

DatacatalogEmpty delete(string $name, array $optParams = [])

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

(taxonomies.delete)

Parameters

string $name

Required. Resource name of the taxonomy to delete. Note: All policy tags in this taxonomy are also deleted.

array $optParams

Optional parameters.

Return Value

DatacatalogEmpty

Exceptions

Exception

GoogleCloudDatacatalogV1ExportTaxonomiesResponse export(string $parent, array $optParams = [])

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

(taxonomies.export)

Parameters

string $parent

Required. Resource name of the project that the exported taxonomies belong to.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1ExportTaxonomiesResponse

Exceptions

Exception

GoogleCloudDatacatalogV1Taxonomy get(string $name, array $optParams = [])

Gets a taxonomy. (taxonomies.get)

Parameters

string $name

Required. Resource name of the taxonomy to get.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Taxonomy

Exceptions

Exception

Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the IAM policy for a policy tag or a taxonomy. (taxonomies.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

GoogleCloudDatacatalogV1ImportTaxonomiesResponse import(string $parent, GoogleCloudDatacatalogV1ImportTaxonomiesRequest $postBody, array $optParams = [])

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures. (taxonomies.import)

Parameters

string $parent

Required. Resource name of project that the imported taxonomies will belong to.

GoogleCloudDatacatalogV1ImportTaxonomiesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1ImportTaxonomiesResponse

Exceptions

Exception

GoogleCloudDatacatalogV1ListTaxonomiesResponse listProjectsLocationsTaxonomies(string $parent, array $optParams = [])

Lists all taxonomies in a project in a particular location that you have a permission to view. (taxonomies.listProjectsLocationsTaxonomies)

Parameters

string $parent

Required. Resource name of the project to list the taxonomies of.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1ListTaxonomiesResponse

Exceptions

Exception

GoogleCloudDatacatalogV1Taxonomy patch(string $name, GoogleCloudDatacatalogV1Taxonomy $postBody, array $optParams = [])

Updates a taxonomy, including its display name, description, and activated policy types. (taxonomies.patch)

Parameters

string $name

Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

GoogleCloudDatacatalogV1Taxonomy $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Taxonomy

Exceptions

Exception

GoogleCloudDatacatalogV1Taxonomy replace(string $name, GoogleCloudDatacatalogV1ReplaceTaxonomyRequest $postBody, array $optParams = [])

Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the SerializedPolicyTag. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly. (taxonomies.replace)

Parameters

string $name

Required. Resource name of the taxonomy to update.

GoogleCloudDatacatalogV1ReplaceTaxonomyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Taxonomy

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the IAM policy for a policy tag or a taxonomy. (taxonomies.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns your permissions on a specified policy tag or taxonomy.

(taxonomies.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception