2023-01-22
▼ ▲ dataplex.projects.locations.dataAttributeBindings.patch
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Required: Yes
Location: path
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}
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.
Type: string
Location: query
Format: google-fieldmask
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}
HTTP Method: PATCH
Path: v1/{+name}
Description: Updates a DataAttributeBinding resource.
▼ ▲ dataplex.projects.locations.dataAttributeBindings.create
Parameters:
validateOnly
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
parent
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}
dataAttributeBindingId
Type: string
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.
Parameter Order: parent
Path: v1/{+parent}/dataAttributeBindings
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a DataAttributeBinding resource.
▼ ▲ dataplex.projects.locations.dataAttributeBindings.list
Description: Lists DataAttributeBinding resources in a project and location.
Parameters:
pageSize
Format: int32
Type: integer
Location: query
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.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location: projects/{project_number}/locations/{location_id}
Location: path
Type: string
Required: Yes
orderBy
Type: string
Location: query
Description: Optional. Order by fields for the result.
filter
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"
Type: string
pageToken
Location: query
Type: string
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.
Path: v1/{+parent}/dataAttributeBindings
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings
Parameter Order: parent
▼ ▲ dataplex.projects.locations.dataAttributeBindings.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}
HTTP Method: DELETE
Parameter Order: name
Description: Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Location: path
Description: Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
etag
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.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.dataAttributeBindings.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}
Description: Retrieves a DataAttributeBinding resource.
Parameter Order: name
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.dataTaxonomies.create
Description: Create a DataTaxonomy resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
parent
Required: Yes
Location: path
Type: string
Description: 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.
Pattern: ^projects/[^/]+/locations/[^/]+$
dataTaxonomyId
Location: query
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.
validateOnly
Type: boolean
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Path: v1/{+parent}/dataTaxonomies
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies
▼ ▲ dataplex.projects.locations.dataTaxonomies.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}
Parameters:
updateMask
Format: google-fieldmask
Description: Required. Mask of fields to update.
Location: query
Type: string
validateOnly
Location: query
Type: boolean
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Type: string
Description: Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
Location: path
Required: Yes
Description: Updates a DataTaxonomy resource.
HTTP Method: PATCH
Path: v1/{+name}
Parameter Order: name
▼ ▲ dataplex.projects.locations.dataTaxonomies.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}
Parameter Order: name
HTTP Method: GET
Description: Retrieves a DataTaxonomy resource.
Parameters:
name
Description: Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Type: string
Required: Yes
▼ ▲ dataplex.projects.locations.dataTaxonomies.delete
Parameter Order: name
Path: v1/{+name}
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}
Parameters:
name
Location: path
Description: Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Required: Yes
Type: string
etag
Type: string
Description: Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.
Location: query
Description: Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
▼ ▲ dataplex.projects.locations.dataTaxonomies.list
Parameter Order: parent
Description: Lists DataTaxonomy resources in a project and location.
Path: v1/{+parent}/dataTaxonomies
HTTP Method: GET
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: 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.
Type: string
orderBy
Type: string
Description: Optional. Order by fields for the result.
Location: query
filter
Description: Optional. Filter request.
Type: string
Location: query
pageToken
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.
Type: string
pageSize
Type: integer
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.patch
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a DataAttribute resource.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}
HTTP Method: PATCH
Parameters:
name
Location: path
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}.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
updateMask
Location: query
Type: string
Description: Required. Mask of fields to update.
Format: google-fieldmask
validateOnly
Type: boolean
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Parameter Order: name
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
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.
name
Type: string
Required: Yes
Description: Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
HTTP Method: DELETE
Path: v1/{+name}
Description: Deletes a Data Attribute resource.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.create
Parameter Order: parent
Description: Create a DataAttribute resource.
Path: v1/{+parent}/attributes
Parameters:
parent
Required: Yes
Description: Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Type: string
dataAttributeId
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
Location: query
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
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/attributes
Parameters:
pageToken
Type: string
Location: query
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.
pageSize
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.
Type: integer
Format: int32
Location: query
filter
Location: query
Type: string
Description: Optional. Filter request.
orderBy
Location: query
Description: Optional. Order by fields for the result.
Type: string
parent
Location: path
Description: Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Required: Yes
Description: Lists Data Attribute resources in a DataTaxonomy.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes
HTTP Method: GET
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Description: Required. The resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
Description: Retrieves a Data Attribute resource.
HTTP Method: GET
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}