Method: projects.locations.entryGroups.entries.list

Lists Entries within an EntryGroup.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent Entry Group: projects/{project}/locations/{___location}/entryGroups/{entryGroup}.

Query parameters

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

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 you need to provide the full project id or number.

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"

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 (Entry)
    }
  ],
  "nextPageToken": string
}
Fields
entries[]

object (Entry)

The list of entries under the given parent ___location.
nextPageToken

string

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.