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.
Optional. Page token received from a previous ListEntities call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListEntities must match the call that provided the
page token.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis page provides reference documentation for the \u003ccode\u003eListEntitiesRequest\u003c/code\u003e class within the Google Cloud Dataplex v1 API, used for listing metadata entities.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of \u003ccode\u003eListEntitiesRequest\u003c/code\u003e is 3.6.0, and the page also links to documentation for various previous versions, ranging from 3.5.0 down to 1.0.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListEntitiesRequest\u003c/code\u003e implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and \u003ccode\u003eIPageRequest\u003c/code\u003e, and is used to request a list of metadata entities.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes properties such as \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003ePageSize\u003c/code\u003e, \u003ccode\u003ePageToken\u003c/code\u003e, \u003ccode\u003eParent\u003c/code\u003e, \u003ccode\u003eParentAsZoneName\u003c/code\u003e, and \u003ccode\u003eView\u003c/code\u003e, which can be set to customize and filter the request for entities.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows for retrieving metadata entities within a specified zone, identified by its resource name with the ability to filter results based on entity ID, asset ID, data path, and compatibility requirements.\u003c/p\u003e\n"]]],[],null,["# Cloud Dataplex v1 API - Class ListEntitiesRequest (3.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.8.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.7.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.6.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.5.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.4.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.3.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.2.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.1.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.0.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.15.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.14.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.13.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.12.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.11.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.10.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.9.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.8.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.7.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.6.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.5.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.4.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.3.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.2.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.1.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.0.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/1.0.0/Google.Cloud.Dataplex.V1.ListEntitiesRequest) \n\n public sealed class ListEntitiesRequest : IMessage\u003cListEntitiesRequest\u003e, IEquatable\u003cListEntitiesRequest\u003e, IDeepCloneable\u003cListEntitiesRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Cloud Dataplex v1 API class ListEntitiesRequest.\n\nList metadata entities request. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListEntitiesRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListEntitiesRequest](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListEntitiesRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListEntitiesRequest](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListEntitiesRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListEntitiesRequest](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListEntitiesRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dataplex.V1](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Dataplex.V1.dll\n\nConstructors\n------------\n\n### ListEntitiesRequest()\n\n public ListEntitiesRequest()\n\n### ListEntitiesRequest(ListEntitiesRequest)\n\n public ListEntitiesRequest(ListEntitiesRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\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### PageSize\n\n public int PageSize { get; set; }\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### PageToken\n\n public string PageToken { get; set; }\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### Parent\n\n public string Parent { get; set; }\n\nRequired. The resource name of the parent zone:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.\n\n### ParentAsZoneName\n\n public ZoneName ParentAsZoneName { get; set; }\n\n[ZoneName](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ZoneName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListEntitiesRequest#Google_Cloud_Dataplex_V1_ListEntitiesRequest_Parent) resource name property.\n\n### View\n\n public ListEntitiesRequest.Types.EntityView View { get; set; }\n\nRequired. Specify the entity view to make a partial list request."]]
