- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog .
HTTP request
GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/entryGroups/*}/entries
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent
|
Required. The resource name of the parent Entry Group: |
Query parameters
pageSize
integer
Optional. Number of items to return per page. If there are remaining results, the service returns a nextPageToken. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
Optional. Page token received from a previous entries.list
call. Provide this to retrieve the subsequent page.
filter
string
Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields:
- entryType
- entrySource.display_name
- parentEntry
The comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.
You can use the logical operators AND, OR, NOT in the filter.
You can use Wildcard "*", but for entryType and parentEntry you need to provide the full project id or number.
You cannot use parentEntry in conjunction with other fields.
Example filter expressions:
- "entrySource.display_name=AnExampleDisplayName"
- "entryType=projects/example-project/locations/global/entryTypes/example-entryType"
- "entryType=projects/example-project/locations/us/entryTypes/a* OR entryType=projects/another-project/locations/*"
- "NOT entrySource.display_name=AnotherExampleDisplayName"
- "parentEntry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"
Request body
The request body must be empty.
Response body
List Entries response.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"entries"
:
[
{
object (
|
| Fields | |
|---|---|
entries[]
|
The list of entries under the given parent location. |
nextPageToken
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
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.entries.list
For more information, see the IAM documentation .
