Cloud Dataplex API (dataplex:v1)

Deletions

Methods


• ▼ ▲ dataplex.projects.locations.dataTaxonomies.get

  HTTP Method : GET

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}

  Path : v1/{+name}

  Description : Retrieves a DataTaxonomy resource.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Parameters :

  name

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$

  Required : Yes

  Parameter Order : name

  Deprecated : Yes

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.patch

  Description : Updates a DataTaxonomy resource.

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}

  Path : v1/{+name}

  Deprecated : Yes

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Parameters :

  name

  Description : Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$

  validateOnly

  Description : Optional. Only validate the request, but do not perform mutations. The default is false.

  Type : boolean

  Location : query

  updateMask

  Description : Required. Mask of fields to update.

  Format : google-fieldmask

  Type : string

  Location : query

  HTTP Method : PATCH

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.create

  Deprecated : Yes

  Parameter Order : parent

  Path : v1/{+parent}/dataTaxonomies

  Parameters :

  parent

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Required : Yes

  dataTaxonomyId

  Type : string

  Description : Required. DataTaxonomy identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Project.

  Location : query

  validateOnly

  Description : Optional. Only validate the request, but do not perform mutations. The default is false.

  Type : boolean

  Location : query

  HTTP Method : POST

  Description : Create a DataTaxonomy resource.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.list

  Parameter Order : parent

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies

  HTTP Method : GET

  Path : v1/{+parent}/dataTaxonomies

  Parameters :

  pageSize

  Type : integer

  Description : Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  Format : int32

  Location : query

  pageToken

  Description : Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token.

  Location : query

  Type : string

  parent

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Type : string

  Description : Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.

  orderBy

  Description : Optional. Order by fields for the result.

  Type : string

  Location : query

  filter

  Type : string

  Location : query

  Description : Optional. Filter request.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Description : Lists DataTaxonomy resources in a project and location.

  Deprecated : Yes

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.delete

  Deprecated : Yes

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  HTTP Method : DELETE

  Parameter Order : name

  Description : Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.

  Parameters :

  name

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

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$

  Required : Yes

  etag

  Description : Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.

  Location : query

  Type : string

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.list

  HTTP Method : GET

  Parameters :

  parent

  Location : path

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

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$

  Type : string

  Required : Yes

  filter

  Type : string

  Location : query

  Description : Optional. Filter request.

  orderBy

  Type : string

  Description : Optional. Order by fields for the result.

  Location : query

  pageSize

  Location : query

  Description : Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  Format : int32

  Type : integer

  pageToken

  Description : Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token.

  Location : query

  Type : string

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Deprecated : Yes

  Parameter Order : parent

  Description : Lists Data Attribute resources in a DataTaxonomy.

  Path : v1/{+parent}/attributes

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.get

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  HTTP Method : GET

  Description : Retrieves a Data Attribute resource.

  Parameters :

  name

  Required : Yes

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$

  Description : Required. The resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

  Parameter Order : name

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}

  Deprecated : Yes

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.create

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Description : Create a DataAttribute resource.

  Path : v1/{+parent}/attributes

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes

  Deprecated : Yes

  HTTP Method : POST

  Parameters :

  parent

  Type : string

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$

  Description : Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}

  validateOnly

  Description : Optional. Only validate the request, but do not perform mutations. The default is false.

  Location : query

  Type : boolean

  dataAttributeId

  Location : query

  Description : Required. DataAttribute identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the DataTaxonomy.

  Type : string

  Parameter Order : parent

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.patch

  HTTP Method : PATCH

  Parameters :

  name

  Type : string

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$

  Description : Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

  updateMask

  Location : query

  Type : string

  Format : google-fieldmask

  Description : Required. Mask of fields to update.

  validateOnly

  Location : query

  Type : boolean

  Description : Optional. Only validate the request, but do not perform mutations. The default is false.

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}

  Path : v1/{+name}

  Description : Updates a DataAttribute resource.

  Deprecated : Yes

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

• ▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.delete

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$

  Type : string

  etag

  Description : Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.

  Location : query

  Type : string

  Description : Deletes a Data Attribute resource.

  Deprecated : Yes

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}

  Path : v1/{+name}

  Parameter Order : name

• ▼ ▲ dataplex.projects.locations.dataAttributeBindings.create

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings

  Parameter Order : parent

  Description : Create a DataAttributeBinding resource.

  Deprecated : Yes

  HTTP Method : POST

  Parameters :

  validateOnly

  Description : Optional. Only validate the request, but do not perform mutations. The default is false.

  Type : boolean

  Location : query

  dataAttributeBindingId

  Location : query

  Description : Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.

  Type : string

  parent

  Location : path

  Description : Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Path : v1/{+parent}/dataAttributeBindings

• ▼ ▲ dataplex.projects.locations.dataAttributeBindings.list

  Parameter Order : parent

  Description : Lists DataAttributeBinding resources in a project and location.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Path : v1/{+parent}/dataAttributeBindings

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings

  Deprecated : Yes

  HTTP Method : GET

  Parameters :

  orderBy

  Location : query

  Type : string

  Description : Optional. Order by fields for the result.

  pageSize

  Format : int32

  Description : Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  Location : query

  Type : integer

  pageToken

  Description : Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token.

  Location : query

  Type : string

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Type : string

  Required : Yes

  Description : Required. The resource name of the Location: projects/{project_number}/locations/{location_id}

  Location : path

  filter

  Type : string

  Location : query

  Description : Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name"

• ▼ ▲ dataplex.projects.locations.dataAttributeBindings.get

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Description : Retrieves a DataAttributeBinding resource.

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$

  Required : Yes

  Parameter Order : name

  Deprecated : Yes

• ▼ ▲ dataplex.projects.locations.dataAttributeBindings.delete

  Parameter Order : name

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}

  Description : Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

  Deprecated : Yes

  HTTP Method : DELETE

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$

  Location : path

  Required : Yes

  Description : Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}

  etag

  Location : query

  Description : Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding.

  Type : string

• ▼ ▲ dataplex.projects.locations.dataAttributeBindings.patch

  Parameter Order : name

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dataplex.read-write

  Description : Updates a DataAttributeBinding resource.

  Path : v1/{+name}

  HTTP Method : PATCH

  Parameters :

  updateMask

  Description : Required. Mask of fields to update.

  Location : query

  Format : google-fieldmask

  Type : string

  validateOnly

  Type : boolean

  Description : Optional. Only validate the request, but do not perform mutations. The default is false.

  Location : query

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$

  Required : Yes

  Type : string

  Description : Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}

  Location : path

  Deprecated : Yes