Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntriesRequest.
List Entries request.
Generated from protobuf messagegoogle.cloud.dataplex.v1.ListEntriesRequest
Namespace
Google \ Cloud \ Dataplex \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the parent Entry Group:projects/{project}/locations/{location}/entryGroups/{entry_group}.
↳ page_size
int
Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.
↳ page_token
string
Optional. Page token received from a previousListEntriescall. 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: * * entry_type * * entry_source.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 entry_type you need to provide the full project id or number. Example filter expressions: * * "entry_source.display_name=AnExampleDisplayName" * * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" * * "entry_type=projects/example-project/locations/us/entryTypes/aOR entry_type=projects/another-project/locations/*" * * "NOT entry_source.display_name=AnotherExampleDisplayName"
getParent
Required. The resource name of the parent Entry Group:projects/{project}/locations/{location}/entryGroups/{entry_group}.
Returns
Type
Description
string
setParent
Required. The resource name of the parent Entry Group:projects/{project}/locations/{location}/entryGroups/{entry_group}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Number of items to return per page. If there are remaining
results, the service returns a next_page_token. If unspecified, the service
returns at most 10 Entries. The maximum value is 100; values above 100 will
be coerced to 100.
Returns
Type
Description
int
setPageSize
Optional. Number of items to return per page. If there are remaining
results, the service returns a next_page_token. If unspecified, the service
returns at most 10 Entries. The maximum value is 100; values above 100 will
be coerced to 100.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. Page token received from a previousListEntriescall. Provide
this to retrieve the subsequent page.
Returns
Type
Description
string
setPageToken
Optional. Page token received from a previousListEntriescall. Provide
this to retrieve the subsequent page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. A filter on the entries to return. Filters are case-sensitive.
You can filter the request by the following fields:
entry_type
entry_source.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 entry_type you need to provide the
full project id or number.
Example filter expressions:
Optional. A filter on the entries to return. Filters are case-sensitive.
You can filter the request by the following fields:
entry_type
entry_source.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 entry_type you need to provide the
full project id or number.
Example filter expressions:
Required. The resource name of the parent Entry Group:projects/{project}/locations/{location}/entryGroups/{entry_group}. Please seeCatalogServiceClient::entryGroupName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class ListEntriesRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.ListEntriesRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.ListEntriesRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.ListEntriesRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.ListEntriesRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.ListEntriesRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.ListEntriesRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.ListEntriesRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.ListEntriesRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.ListEntriesRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.ListEntriesRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.ListEntriesRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.ListEntriesRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.ListEntriesRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.ListEntriesRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.ListEntriesRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.ListEntriesRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.ListEntriesRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.ListEntriesRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.ListEntriesRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.ListEntriesRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.ListEntriesRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.ListEntriesRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.ListEntriesRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.ListEntriesRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntriesRequest.\n\nList Entries request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.ListEntriesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the parent Entry Group:\n`projects/{project}/locations/{location}/entryGroups/{entry_group}`.\n\n### setParent\n\nRequired. The resource name of the parent Entry Group:\n`projects/{project}/locations/{location}/entryGroups/{entry_group}`.\n\n### getPageSize\n\nOptional. Number of items to return per page. If there are remaining\nresults, the service returns a next_page_token. If unspecified, the service\nreturns at most 10 Entries. The maximum value is 100; values above 100 will\nbe coerced to 100.\n\n### setPageSize\n\nOptional. Number of items to return per page. If there are remaining\nresults, the service returns a next_page_token. If unspecified, the service\nreturns at most 10 Entries. The maximum value is 100; values above 100 will\nbe coerced to 100.\n\n### getPageToken\n\nOptional. Page token received from a previous `ListEntries` call. Provide\nthis to retrieve the subsequent page.\n\n### setPageToken\n\nOptional. Page token received from a previous `ListEntries` call. Provide\nthis to retrieve the subsequent page.\n\n### getFilter\n\nOptional. A filter on the entries to return. Filters are case-sensitive.\n\nYou can filter the request by the following fields:\n\n- entry_type\n- entry_source.display_name The comparison operators are =, !=, \\\u003c, \\\u003e, \\\u003c=, \\\u003e=. 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 entry_type you need to provide the full project id or number. Example filter expressions:\n- \"entry_source.display_name=AnExampleDisplayName\"\n- \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\"\n- \"entry_type=projects/example-project/locations/us/entryTypes/a\\* OR entry_type=projects/another-project/locations/\\*\"\n- \"NOT entry_source.display_name=AnotherExampleDisplayName\"\n\n### setFilter\n\nOptional. A filter on the entries to return. Filters are case-sensitive.\n\nYou can filter the request by the following fields:\n\n- entry_type\n- entry_source.display_name The comparison operators are =, !=, \\\u003c, \\\u003e, \\\u003c=, \\\u003e=. 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 entry_type you need to provide the full project id or number. Example filter expressions:\n- \"entry_source.display_name=AnExampleDisplayName\"\n- \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\"\n- \"entry_type=projects/example-project/locations/us/entryTypes/a\\* OR entry_type=projects/another-project/locations/\\*\"\n- \"NOT entry_source.display_name=AnotherExampleDisplayName\"\n\n### static::build"]]
