2025-12-11
▼ ▲ dataplex.projects.locations.dataProducts.create
Path : v1/{+parent}/dataProducts
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this Data Product will be created. Format: projects/{project_id_or_number}/locations/{location_id}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
dataProductId
Description : Optional. The ID of the Data Product to create.The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: (^a-z?$) If not provided, a system generated ID will be used.
Location : query
Type : string
validateOnly
Description : Optional. Validates the request without actually creating the Data Product. Default: false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Data Product.
▼ ▲ dataplex.projects.locations.dataProducts.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Data Product to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. The etag of the Data Product.If an etag is provided and does not match the current etag of the Data Product, then the deletion will be blocked and an ABORTED error will be returned.
Location : query
Type : string
validateOnly
Description : Optional. Validates the request without actually deleting the Data Product. Default: false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Data Product. The deletion will fail if the Data Product is not empty (i.e. contains at least one Data Asset).
▼ ▲ dataplex.projects.locations.dataProducts.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Data Product to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Data Product.
▼ ▲ dataplex.projects.locations.dataProducts.list
Path : v1/{+parent}/dataProducts
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which has this collection of Data Products.Format: projects/{project_id_or_number}/locations/{location_id}.Supports listing across all locations with the wildcard - (hyphen) character. Example: projects/{project_id_or_number}/locations/-
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Filter expression that filters Data Products listed in the response.Example of using this filter is: display_name="my-data-product"
Location : query
Type : string
pageSize
Description : Optional. The maximum number of Data Products to return. The service may return fewer than this value. If unspecified, at most 50 Data Products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous ListDataProducts call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to ListDataProducts must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. Order by expression that orders Data Products listed in the response.Supported Order by fields are: name or create_time.If not specified, the ordering is undefined.Ordering by create_time is not supported when listing resources across locations (i.e. when request contains /locations/-).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Data Products for a given project.
▼ ▲ dataplex.projects.locations.dataProducts.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the Data Product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update. If this is empty or not set, then all the fields will be updated.
Location : query
Type : string
Format : google-fieldmask
validateOnly
Description : Optional. Validates the request without actually updating the Data Product. Default: false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Data Product.
▼ ▲ dataplex.projects.locations.dataProducts.dataAssets.create
Path : v1/{+parent}/dataAssets
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this Data Asset will be created. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$
Location : path
Required : Yes
Type : string
dataAssetId
Description : Optional. The ID of the Data Asset to create.The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: (^a-z?$) If not provided, a system generated ID will be used.
Location : query
Type : string
validateOnly
Description : Optional. Validates the request without actually creating the Data Asset. Defaults to false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Data Asset.
▼ ▲ dataplex.projects.locations.dataProducts.dataAssets.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the Data Asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update. If this is empty or not set, then all fields that are populated (have a non-empty value) in data_asset above will be updated.
Location : query
Type : string
Format : google-fieldmask
validateOnly
Description : Optional. Validates the request without actually updating the Data Asset. Defaults to false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Data Asset.
▼ ▲ dataplex.projects.locations.dataProducts.dataAssets.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Data Asset to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. The etag of the Data Asset. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
Location : query
Type : string
validateOnly
Description : Optional. Validates the request without actually deleting the Data Asset. Defaults to false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Data Asset.
▼ ▲ dataplex.projects.locations.dataProducts.dataAssets.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Data Asset to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Data Asset.
▼ ▲ dataplex.projects.locations.dataProducts.dataAssets.list
Path : v1/{+parent}/dataAssets
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which has this collection of Data Assets. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
Pattern : ^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Filter expression that filters DataAssets listed in the response.
Location : query
Type : string
orderBy
Description : Optional. Order by expression that orders DataAssets listed in the response.Supported Order by fields are: name or create_time.If not specified, the ordering is undefined.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of Data Assets to return. The service may return fewer than this value. If unspecified, at most 50 Data Assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous ListDataAssets call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to ListDataAssets must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Data Assets for a given Data Product.