Cloud Dataplex API

Dataplex API is used to manage the lifecycle of data lakes.

Service: dataplex.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://dataplex.googleapis.com

REST Resource: v1.organizations.locations.operations

Methods
cancel POST /v1/{name=organizations/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=organizations/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=organizations/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
listOperations GET /v1/{name=organizations/*/locations/*/operations/*}
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.
lookupEntry GET /v1/{name=projects/*/locations/*}:lookupEntry
Looks up a single Entry by name using the permission on the source system.
searchEntries POST /v1/{name=projects/*/locations/*}:searchEntries
Searches for Entries matching the given query and scope.

REST Resource: v1.projects.locations.aspectTypes

Methods
create POST /v1/{parent=projects/*/locations/*}/aspectTypes
Creates an AspectType.
delete DELETE /v1/{name=projects/*/locations/*/aspectTypes/*}
Deletes an AspectType.
get GET /v1/{name=projects/*/locations/*/aspectTypes/*}
Gets an AspectType.
getIamPolicy GET /v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/aspectTypes
Lists AspectType resources in a project and location.
patch PATCH /v1/{aspectType.name=projects/*/locations/*/aspectTypes/*}
Updates an AspectType.
setIamPolicy POST /v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.dataAttributeBindings

Methods
create POST /v1/{parent=projects/*/locations/*}/dataAttributeBindings
Create a DataAttributeBinding resource.
delete DELETE /v1/{name=projects/*/locations/*/dataAttributeBindings/*}
Deletes a DataAttributeBinding resource.
get GET /v1/{name=projects/*/locations/*/dataAttributeBindings/*}
Retrieves a DataAttributeBinding resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/dataAttributeBindings
Lists DataAttributeBinding resources in a project and location.
patch PATCH /v1/{dataAttributeBinding.name=projects/*/locations/*/dataAttributeBindings/*}
Updates a DataAttributeBinding resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.dataScans

Methods
create POST /v1/{parent=projects/*/locations/*}/dataScans
Creates a DataScan resource.
delete DELETE /v1/{name=projects/*/locations/*/dataScans/*}
Deletes a DataScan resource.
generateDataQualityRules POST /v1/{name=projects/*/locations/*/dataScans/*}:generateDataQualityRules
Generates recommended data quality rules based on the results of a data profiling scan.
get GET /v1/{name=projects/*/locations/*/dataScans/*}
Gets a DataScan resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/dataScans/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/dataScans
Lists DataScans.
patch PATCH /v1/{dataScan.name=projects/*/locations/*/dataScans/*}
Updates a DataScan resource.
run POST /v1/{name=projects/*/locations/*/dataScans/*}:run
Runs an on-demand execution of a DataScan
setIamPolicy POST /v1/{resource=projects/*/locations/*/dataScans/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/dataScans/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.dataScans.jobs

Methods
generateDataQualityRules POST /v1/{name=projects/*/locations/*/dataScans/*/jobs/*}:generateDataQualityRules
Generates recommended data quality rules based on the results of a data profiling scan.
get GET /v1/{name=projects/*/locations/*/dataScans/*/jobs/*}
Gets a DataScanJob resource.
list GET /v1/{parent=projects/*/locations/*/dataScans/*}/jobs
Lists DataScanJobs under the given DataScan.

REST Resource: v1.projects.locations.dataTaxonomies

Methods
create POST /v1/{parent=projects/*/locations/*}/dataTaxonomies
Create a DataTaxonomy resource.
delete DELETE /v1/{name=projects/*/locations/*/dataTaxonomies/*}
Deletes a DataTaxonomy resource.
get GET /v1/{name=projects/*/locations/*/dataTaxonomies/*}
Retrieves a DataTaxonomy resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/dataTaxonomies/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/dataTaxonomies
Lists DataTaxonomy resources in a project and location.
patch PATCH /v1/{dataTaxonomy.name=projects/*/locations/*/dataTaxonomies/*}
Updates a DataTaxonomy resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/dataTaxonomies/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/dataTaxonomies/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.dataTaxonomies.attributes

Methods
create POST /v1/{parent=projects/*/locations/*/dataTaxonomies/*}/attributes
Create a DataAttribute resource.
delete DELETE /v1/{name=projects/*/locations/*/dataTaxonomies/*/attributes/*}
Deletes a Data Attribute resource.
get GET /v1/{name=projects/*/locations/*/dataTaxonomies/*/attributes/*}
Retrieves a Data Attribute resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/dataTaxonomies/*}/attributes
Lists Data Attribute resources in a DataTaxonomy.
patch PATCH /v1/{dataAttribute.name=projects/*/locations/*/dataTaxonomies/*/attributes/*}
Updates a DataAttribute resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.entryGroups

Methods
create POST /v1/{parent=projects/*/locations/*}/entryGroups
Creates an EntryGroup.
delete DELETE /v1/{name=projects/*/locations/*/entryGroups/*}
Deletes an EntryGroup.
get GET /v1/{name=projects/*/locations/*/entryGroups/*}
Gets an EntryGroup.
getIamPolicy GET /v1/{resource=projects/*/locations/*/entryGroups/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/entryGroups
Lists EntryGroup resources in a project and location.
patch PATCH /v1/{entryGroup.name=projects/*/locations/*/entryGroups/*}
Updates an EntryGroup.
setIamPolicy POST /v1/{resource=projects/*/locations/*/entryGroups/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/entryGroups/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.entryGroups.entries

Methods
create POST /v1/{parent=projects/*/locations/*/entryGroups/*}/entries
Creates an Entry.
delete DELETE /v1/{name=projects/*/locations/*/entryGroups/*/entries/**}
Deletes an Entry.
get GET /v1/{name=projects/*/locations/*/entryGroups/*/entries/**}
Gets an Entry.
list GET /v1/{parent=projects/*/locations/*/entryGroups/*}/entries
Lists Entries within an EntryGroup.
patch PATCH /v1/{entry.name=projects/*/locations/*/entryGroups/*/entries/**}
Updates an Entry.

REST Resource: v1.projects.locations.entryTypes

Methods
create POST /v1/{parent=projects/*/locations/*}/entryTypes
Creates an EntryType.
delete DELETE /v1/{name=projects/*/locations/*/entryTypes/*}
Deletes an EntryType.
get GET /v1/{name=projects/*/locations/*/entryTypes/*}
Gets an EntryType.
getIamPolicy GET /v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/entryTypes
Lists EntryType resources in a project and location.
patch PATCH /v1/{entryType.name=projects/*/locations/*/entryTypes/*}
Updates an EntryType.
setIamPolicy POST /v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.lakes

Methods
create POST /v1/{parent=projects/*/locations/*}/lakes
Creates a lake resource.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*}
Deletes a lake resource.
get GET /v1/{name=projects/*/locations/*/lakes/*}
Retrieves a lake resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/lakes
Lists lake resources in a project and location.
patch PATCH /v1/{lake.name=projects/*/locations/*/lakes/*}
Updates a lake resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.lakes.actions

Methods
list GET /v1/{parent=projects/*/locations/*/lakes/*}/actions
Lists action resources in a lake.

REST Resource: v1.projects.locations.lakes.content

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*}/content
Create a content.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/content/**}
Delete a content.
get GET /v1/{name=projects/*/locations/*/lakes/*/content/**}
Get a content resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*/content/**}:getIamPolicy
Gets the access control policy for a contentitem resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*}/content
List content.
patch PATCH /v1/{content.name=projects/*/locations/*/lakes/*/content/**}
Update a content.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*/content/**}:setIamPolicy
Sets the access control policy on the specified contentitem resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*/content/**}:testIamPermissions
Returns the caller's permissions on a resource.

REST Resource: v1.projects.locations.lakes.contentitems

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*}/contentitems
Create a content.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/contentitems/**}
Delete a content.
get GET /v1/{name=projects/*/locations/*/lakes/*/contentitems/**}
Get a content resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*/contentitems/**}:getIamPolicy
Gets the access control policy for a contentitem resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*}/contentitems
List content.
patch PATCH /v1/{content.name=projects/*/locations/*/lakes/*/contentitems/**}
Update a content.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*/contentitems/**}:setIamPolicy
Sets the access control policy on the specified contentitem resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*/contentitems/**}:testIamPermissions
Returns the caller's permissions on a resource.

REST Resource: v1.projects.locations.lakes.environments

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*}/environments
Create an environment resource.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/environments/*}
Delete the environment resource.
get GET /v1/{name=projects/*/locations/*/lakes/*/environments/*}
Get environment resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*/environments/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*}/environments
Lists environments under the given lake.
patch PATCH /v1/{environment.name=projects/*/locations/*/lakes/*/environments/*}
Update the environment resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*/environments/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*/environments/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.lakes.environments.sessions

Methods
list GET /v1/{parent=projects/*/locations/*/lakes/*/environments/*}/sessions
Lists session resources in an environment.

REST Resource: v1.projects.locations.lakes.tasks

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*}/tasks
Creates a task resource within a lake.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/tasks/*}
Delete the task resource.
get GET /v1/{name=projects/*/locations/*/lakes/*/tasks/*}
Get task resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*}/tasks
Lists tasks under the given lake.
patch PATCH /v1/{task.name=projects/*/locations/*/lakes/*/tasks/*}
Update the task resource.
run POST /v1/{name=projects/*/locations/*/lakes/*/tasks/*}:run
Run an on demand execution of a Task.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.lakes.tasks.jobs

Methods
cancel POST /v1/{name=projects/*/locations/*/lakes/*/tasks/*/jobs/*}:cancel
Cancel jobs running for the task resource.
get GET /v1/{name=projects/*/locations/*/lakes/*/tasks/*/jobs/*}
Get job resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*/tasks/*}/jobs
Lists Jobs under the given task.

REST Resource: v1.projects.locations.lakes.zones

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*}/zones
Creates a zone resource within a lake.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/zones/*}
Deletes a zone resource.
get GET /v1/{name=projects/*/locations/*/lakes/*/zones/*}
Retrieves a zone resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*/zones/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*}/zones
Lists zone resources in a lake.
patch PATCH /v1/{zone.name=projects/*/locations/*/lakes/*/zones/*}
Updates a zone resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*/zones/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*/zones/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.lakes.zones.actions

Methods
list GET /v1/{parent=projects/*/locations/*/lakes/*/zones/*}/actions
Lists action resources in a zone.

REST Resource: v1.projects.locations.lakes.zones.assets

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*/zones/*}/assets
Creates an asset resource.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/zones/*/assets/*}
Deletes an asset resource.
get GET /v1/{name=projects/*/locations/*/lakes/*/zones/*/assets/*}
Retrieves an asset resource.
getIamPolicy GET /v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/lakes/*/zones/*}/assets
Lists asset resources in a zone.
patch PATCH /v1/{asset.name=projects/*/locations/*/lakes/*/zones/*/assets/*}
Updates an asset resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.lakes.zones.assets.actions

Methods
list GET /v1/{parent=projects/*/locations/*/lakes/*/zones/*/assets/*}/actions
Lists action resources in an asset.

REST Resource: v1.projects.locations.lakes.zones.entities

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*/zones/*}/entities
Create a metadata entity.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/zones/*/entities/*}
Delete a metadata entity.
get GET /v1/{name=projects/*/locations/*/lakes/*/zones/*/entities/*}
Get a metadata entity.
list GET /v1/{parent=projects/*/locations/*/lakes/*/zones/*}/entities
List metadata entities in a zone.
update PUT /v1/{entity.name=projects/*/locations/*/lakes/*/zones/*/entities/*}
Update a metadata entity.

REST Resource: v1.projects.locations.lakes.zones.entities.partitions

Methods
create POST /v1/{parent=projects/*/locations/*/lakes/*/zones/*/entities/*}/partitions
Create a metadata partition.
delete DELETE /v1/{name=projects/*/locations/*/lakes/*/zones/*/entities/*/partitions/**}
Delete a metadata partition.
get GET /v1/{name=projects/*/locations/*/lakes/*/zones/*/entities/*/partitions/**}
Get a metadata partition of an entity.
list GET /v1/{parent=projects/*/locations/*/lakes/*/zones/*/entities/*}/partitions
List metadata partitions of an entity.

REST Resource: v1.projects.locations.metadataJobs

Methods
cancel POST /v1/{name=projects/*/locations/*/metadataJobs/*}:cancel
Cancels a metadata job.
create POST /v1/{parent=projects/*/locations/*}/metadataJobs
Creates a metadata job.
get GET /v1/{name=projects/*/locations/*/metadataJobs/*}
Gets a metadata job.
list GET /v1/{parent=projects/*/locations/*}/metadataJobs
Lists metadata jobs.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.