1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudDataplex
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDataTaxonomies

ProjectsLocationsDataTaxonomies

class ProjectsLocationsDataTaxonomies extends Resource (View source)

The "dataTaxonomies" collection of methods.

Typical usage is:

 $dataplexService = new Google\Service\CloudDataplex(...);
 $dataTaxonomies = $dataplexService->projects_locations_dataTaxonomies;

Methods

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

Create a DataTaxonomy resource. (dataTaxonomies.create)

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

Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. (dataTaxonomies.delete)

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

Retrieves a DataTaxonomy resource. (dataTaxonomies.get)

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

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (dataTaxonomies.getIamPolicy)

GoogleCloudDataplexV1ListDataTaxonomiesResponse
listProjectsLocationsDataTaxonomies(string $parent, array $optParams = [])

Lists DataTaxonomy resources in a project and location.

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

Updates a DataTaxonomy resource. (dataTaxonomies.patch)

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

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (dataTaxonomies.setIamPolicy)

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

at line 56
GoogleLongrunningOperation create(string $parent, GoogleCloudDataplexV1DataTaxonomy $postBody, array $optParams = [])

Create a DataTaxonomy resource. (dataTaxonomies.create)

Parameters

string $parent

Required. The resource name of the data taxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
GoogleCloudDataplexV1DataTaxonomy $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 76
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. (dataTaxonomies.delete)

Parameters

string $name

Required. The resource name of the DataTaxonomy: projects /{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 91
GoogleCloudDataplexV1DataTaxonomy get(string $name, array $optParams = [])

Retrieves a DataTaxonomy resource. (dataTaxonomies.get)

Parameters

string $name

Required. The resource name of the DataTaxonomy: projects /{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1DataTaxonomy

Exceptions

Exception

at line 121
GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (dataTaxonomies.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

at line 149
GoogleCloudDataplexV1ListDataTaxonomiesResponse listProjectsLocationsDataTaxonomies(string $parent, array $optParams = [])

Lists DataTaxonomy resources in a project and location.

(dataTaxonomies.listProjectsLocationsDataTaxonomies)

Parameters

string $parent

Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1ListDataTaxonomiesResponse

Exceptions

Exception

at line 170
GoogleLongrunningOperation patch(string $name, GoogleCloudDataplexV1DataTaxonomy $postBody, array $optParams = [])

Updates a DataTaxonomy resource. (dataTaxonomies.patch)

Parameters

string $name

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/ dataTaxonomies/{data_taxonomy_id}.
GoogleCloudDataplexV1DataTaxonomy $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 190
GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (dataTaxonomies.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

at line 213
GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (dataTaxonomies.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
GoogleIamV1TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception