2026-10-02
▼ ▲ dataplex.projects.locations.agentTasks.testIamPermissions
Scopes :
Parameter Order : resource
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentTasks/{agentTasksId}:testIamPermissions
Parameters :
resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agentTasks/[^/]+$
Type : string
Description : 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.
Description : 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.
Path : v1/{+resource}:testIamPermissions
▼ ▲ dataplex.projects.locations.agentTasks.getIamPolicy
Parameters :
resource
Description : 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.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agentTasks/[^/]+$
options.requestedPolicyVersion
Format : int32
Location : query
Description : Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentTasks/{agentTasksId}:getIamPolicy
HTTP Method : GET
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Scopes :
▼ ▲ dataplex.projects.locations.agentTasks.setIamPolicy
Path : v1/{+resource}:setIamPolicy
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentTasks/{agentTasksId}:setIamPolicy
Scopes :
Parameters :
resource
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agentTasks/[^/]+$
Location : path
Required : Yes
Description : 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.
Parameter Order : resource
Description : Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
▼ ▲ dataplex.projects.locations.dataTaxonomies.create
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies
Scopes :
HTTP Method : POST
Deprecated : Yes
Description : Create a DataTaxonomy resource.
Path : v1/{+parent}/dataTaxonomies
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
dataTaxonomyId
Location : query
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.
Type : string
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
▼ ▲ dataplex.projects.locations.dataTaxonomies.delete
Scopes :
Parameter Order : name
Parameters :
name
Description : Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Required : Yes
etag
Location : query
Description : Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}
Description : Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
Deprecated : Yes
HTTP Method : DELETE
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.dataTaxonomies.get
Description : Retrieves a DataTaxonomy resource.
Path : v1/{+name}
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}
Parameter Order : name
Scopes :
Deprecated : Yes
HTTP Method : GET
▼ ▲ dataplex.projects.locations.dataTaxonomies.list
Description : Lists DataTaxonomy resources in a project and location.
Parameters :
pageSize
Format : int32
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.
Location : query
Type : integer
pageToken
Type : string
Location : query
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.
orderBy
Location : query
Type : string
Description : Optional. Order by fields for the result.
parent
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.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
filter
Description : Optional. Filter request.
Type : string
Location : query
Scopes :
Path : v1/{+parent}/dataTaxonomies
Parameter Order : parent
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies
HTTP Method : GET
▼ ▲ dataplex.projects.locations.dataTaxonomies.patch
HTTP Method : PATCH
Deprecated : Yes
Description : Updates a DataTaxonomy resource.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}
Scopes :
Path : v1/{+name}
Parameters :
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
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
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Location : path
Required : Yes
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Required. Mask of fields to update.
Parameter Order : name
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.patch
HTTP Method : PATCH
Deprecated : Yes
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}
Path : v1/{+name}
Parameter Order : name
Parameters :
updateMask
Type : string
Description : Required. Mask of fields to update.
Format : google-fieldmask
Location : query
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
Location : path
Type : string
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}.
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
Description : Updates a DataAttribute resource.
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.get
Parameter Order : name
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}
Deprecated : Yes
Description : Retrieves a Data Attribute resource.
Path : v1/{+name}
Parameters :
name
Required : Yes
Location : path
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}
Type : string
Scopes :
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes
Path : v1/{+parent}/attributes
HTTP Method : GET
Deprecated : Yes
Scopes :
Description : Lists Data Attribute resources in a DataTaxonomy.
Parameter Order : parent
Parameters :
pageToken
Type : string
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
filter
Location : query
Description : Optional. Filter request.
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Type : string
Description : Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Location : path
Required : Yes
pageSize
Type : integer
Format : int32
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.
orderBy
Description : Optional. Order by fields for the result.
Type : string
Location : query
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes
Path : v1/{+parent}/attributes
Scopes :
Description : Create a DataAttribute resource.
Deprecated : Yes
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Description : Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Type : string
Required : Yes
Location : path
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Type : boolean
Location : query
dataAttributeId
Type : string
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.
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.delete
Parameter Order : name
Scopes :
HTTP Method : DELETE
Description : Deletes a Data Attribute resource.
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
Type : string
Required : Yes
Description : Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
etag
Location : query
Type : string
Description : Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.dataAttributeBindings.create
Parameters :
dataAttributeBindingId
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.
Location : query
Type : string
validateOnly
Location : query
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Type : boolean
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}
Description : Create a DataAttributeBinding resource.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings
Parameter Order : parent
Deprecated : Yes
HTTP Method : POST
Scopes :
Path : v1/{+parent}/dataAttributeBindings
▼ ▲ dataplex.projects.locations.dataAttributeBindings.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}
Scopes :
Parameter Order : name
HTTP Method : PATCH
Deprecated : Yes
Path : v1/{+name}
Description : Updates a DataAttributeBinding resource.
Parameters :
updateMask
Description : Required. Mask of fields to update.
Format : google-fieldmask
Type : string
Location : query
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
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
Required : Yes
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Type : boolean
Location : query
▼ ▲ dataplex.projects.locations.dataAttributeBindings.delete
Path : v1/{+name}
Scopes :
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.
Parameters :
name
Description : Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Location : path
Required : Yes
etag
Type : string
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.
Parameter Order : name
HTTP Method : DELETE
Deprecated : Yes
▼ ▲ dataplex.projects.locations.dataAttributeBindings.get
Parameter Order : name
Scopes :
Parameters :
name
Description : Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Type : string
Required : Yes
Location : path
Description : Retrieves a DataAttributeBinding resource.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}
Deprecated : Yes
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.dataAttributeBindings.list
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings
Scopes :
Path : v1/{+parent}/dataAttributeBindings
HTTP Method : GET
Deprecated : Yes
Description : Lists DataAttributeBinding resources in a project and location.
Parameters :
pageSize
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.
Type : integer
Format : int32
Location : query
parent
Required : Yes
Type : string
Location : path
Description : Required. The resource name of the Location: projects/{project_number}/locations/{location_id}
Pattern : ^projects/[^/]+/locations/[^/]+$
filter
Type : string
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"
Location : query
orderBy
Location : query
Type : string
Description : Optional. Order by fields for the result.
pageToken
Type : string
Location : query
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.