Method: projects.locations.dataProducts.list

Lists data products for a given project.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/dataProducts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which has this collection of data products.

Format: projects/{project_id_or_number}/locations/{locationId}.

Supports listing across all locations with the wildcard - (hyphen) character. Example: projects/{project_id_or_number}/locations/-

Query parameters

Parameters
filter

string

Optional. Filter expression that filters data products listed in the response.

Example of using this filter is: displayName="my-data-product"
pageSize

integer

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.
pageToken

string

Optional. A page token, received from a previous dataProducts.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to dataProducts.list must match the call that provided the page token.
orderBy

string

Optional. Order by expression that orders data products listed in the response.

Supported Order by fields are: name or createTime.

If not specified, the ordering is undefined.

Ordering by createTime is not supported when listing resources across locations (i.e. when request contains /locations/-).

Request body

The request body must be empty.

Response body

Response message for listing data products.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "dataProducts": [
    {
      object (DataProduct)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
dataProducts[]

object (DataProduct)

The data products for the requested filter criteria.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is empty, then there are no subsequent pages.
unreachable[]

string

Unordered list. Locations that the service couldn't reach.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • dataplex.dataProducts.list

For more information, see the IAM documentation.