Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntitiesRequest.
List metadata entities request.
Generated from protobuf messagegoogle.cloud.dataplex.v1.ListEntitiesRequest
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 zone:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
↳ view
int
Required. Specify the entity view to make a partial list request.
↳ page_size
int
Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500.
↳ page_token
string
Optional. Page token received from a previousListEntitiescall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListEntitiesmust match the call that provided the page token.
↳ filter
string
Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: - Entity ID: ?filter="id=entityID" - Asset ID: ?filter="asset=assetID" - Data path ?filter="data_path=gs://my-bucket" - Is HIVE compatible: ?filter="hive_compatible=true" - Is BigQuery compatible: ?filter="bigquery_compatible=true"
getParent
Required. The resource name of the parent zone:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Returns
Type
Description
string
setParent
Required. The resource name of the parent zone:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getView
Required. Specify the entity view to make a partial list request.
Returns
Type
Description
int
setView
Required. Specify the entity view to make a partial list request.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageSize
Optional. Maximum number of entities to return. The service may return
fewer than this value. If unspecified, 100 entities will be returned by
default. The maximum value is 500; larger values will will be truncated to
500.
Returns
Type
Description
int
setPageSize
Optional. Maximum number of entities to return. The service may return
fewer than this value. If unspecified, 100 entities will be returned by
default. The maximum value is 500; larger values will will be truncated to
500.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. Page token received from a previousListEntitiescall. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided toListEntitiesmust match the call that provided the
page token.
Returns
Type
Description
string
setPageToken
Optional. Page token received from a previousListEntitiescall. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided toListEntitiesmust match the call that provided the
page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. The following filter parameters can be added to the URL to limit
the entities returned by the API:
Entity ID: ?filter="id=entityID"
Asset ID: ?filter="asset=assetID"
Data path ?filter="data_path=gs://my-bucket"
Is HIVE compatible: ?filter="hive_compatible=true"
Is BigQuery compatible: ?filter="bigquery_compatible=true"
Returns
Type
Description
string
setFilter
Optional. The following filter parameters can be added to the URL to limit
the entities returned by the API:
Entity ID: ?filter="id=entityID"
Asset ID: ?filter="asset=assetID"
Data path ?filter="data_path=gs://my-bucket"
Is HIVE compatible: ?filter="hive_compatible=true"
Is BigQuery compatible: ?filter="bigquery_compatible=true"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The resource name of the parent zone:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. Please seeMetadataServiceClient::zoneName()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 ListEntitiesRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.ListEntitiesRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.ListEntitiesRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.ListEntitiesRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.ListEntitiesRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.ListEntitiesRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.ListEntitiesRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.ListEntitiesRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.ListEntitiesRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.ListEntitiesRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.ListEntitiesRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.ListEntitiesRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.ListEntitiesRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.ListEntitiesRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.ListEntitiesRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.ListEntitiesRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.ListEntitiesRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.ListEntitiesRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.ListEntitiesRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.ListEntitiesRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.ListEntitiesRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.ListEntitiesRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.ListEntitiesRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.ListEntitiesRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.ListEntitiesRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntitiesRequest.\n\nList metadata entities request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.ListEntitiesRequest`\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 zone:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.\n\n### setParent\n\nRequired. The resource name of the parent zone:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.\n\n### getView\n\nRequired. Specify the entity view to make a partial list request.\n\n### setView\n\nRequired. Specify the entity view to make a partial list request.\n\n### getPageSize\n\nOptional. Maximum number of entities to return. The service may return\nfewer than this value. If unspecified, 100 entities will be returned by\ndefault. The maximum value is 500; larger values will will be truncated to\n500.\n\n### setPageSize\n\nOptional. Maximum number of entities to return. The service may return\nfewer than this value. If unspecified, 100 entities will be returned by\ndefault. The maximum value is 500; larger values will will be truncated to\n500.\n\n### getPageToken\n\nOptional. Page token received from a previous `ListEntities` call. Provide\nthis to retrieve the subsequent page. When paginating, all other parameters\nprovided to `ListEntities` must match the call that provided the\npage token.\n\n### setPageToken\n\nOptional. Page token received from a previous `ListEntities` call. Provide\nthis to retrieve the subsequent page. When paginating, all other parameters\nprovided to `ListEntities` must match the call that provided the\npage token.\n\n### getFilter\n\nOptional. The following filter parameters can be added to the URL to limit\nthe entities returned by the API:\n\n- Entity ID: ?filter=\"id=entityID\"\n- Asset ID: ?filter=\"asset=assetID\"\n- Data path ?filter=\"data_path=gs://my-bucket\"\n- Is HIVE compatible: ?filter=\"hive_compatible=true\"\n- Is BigQuery compatible: ?filter=\"bigquery_compatible=true\"\n\n### setFilter\n\nOptional. The following filter parameters can be added to the URL to limit\nthe entities returned by the API:\n\n- Entity ID: ?filter=\"id=entityID\"\n- Asset ID: ?filter=\"asset=assetID\"\n- Data path ?filter=\"data_path=gs://my-bucket\"\n- Is HIVE compatible: ?filter=\"hive_compatible=true\"\n- Is BigQuery compatible: ?filter=\"bigquery_compatible=true\"\n\n### static::build"]]
