Optional. Filter request. The following mode filter is supported to
return only the sessions belonging to the requester when the mode is USER
and return sessions of all the users when the mode is ADMIN. When no filter
is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
should have dataplex.environments.listAllSessions permission to list all
sessions, in absence of the permission, the request fails.
Optional. Maximum number of sessions to return. The service may return
fewer than this value. If unspecified, at most 10 sessions will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
Optional. Page token received from a previous ListSessions call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListSessions 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\u003eThe latest version of the \u003ccode\u003eListSessionsRequest\u003c/code\u003e class in the Google Cloud Dataplex V1 API is 3.6.0, with multiple prior versions available ranging from 3.5.0 down to 1.0.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListSessionsRequest\u003c/code\u003e class is used to retrieve a list of sessions and implements various interfaces such as \u003ccode\u003eIPageRequest\u003c/code\u003e, \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis class allows filtering of sessions based on user mode (USER or ADMIN) and supports pagination through \u003ccode\u003ePageSize\u003c/code\u003e and \u003ccode\u003ePageToken\u003c/code\u003e properties.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eParent\u003c/code\u003e property is a required field that indicates the parent environment from which to list sessions, specified in the format \u003ccode\u003eprojects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListSessionsRequest\u003c/code\u003e provides constructors for creating new instances and supports property access to manage filtering, pagination, and parent environment, allowing detailed control over the session listing operation.\u003c/p\u003e\n"]]],[],null,["# Cloud Dataplex v1 API - Class ListSessionsRequest (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.ListSessionsRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.8.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.7.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.6.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.5.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.4.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.3.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.2.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.1.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.0.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.15.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.14.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.13.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.12.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.11.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.10.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.9.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.8.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.7.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.6.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.5.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.4.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.3.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.2.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.1.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.0.0/Google.Cloud.Dataplex.V1.ListSessionsRequest)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/1.0.0/Google.Cloud.Dataplex.V1.ListSessionsRequest) \n\n public sealed class ListSessionsRequest : IPageRequest, IMessage\u003cListSessionsRequest\u003e, IEquatable\u003cListSessionsRequest\u003e, IDeepCloneable\u003cListSessionsRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Cloud Dataplex v1 API class ListSessionsRequest.\n\nList sessions request. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListSessionsRequest \n\nImplements\n----------\n\n[IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListSessionsRequest](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListSessionsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListSessionsRequest](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListSessionsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListSessionsRequest](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListSessionsRequest), [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) \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### ListSessionsRequest()\n\n public ListSessionsRequest()\n\n### ListSessionsRequest(ListSessionsRequest)\n\n public ListSessionsRequest(ListSessionsRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\n\nOptional. Filter request. The following `mode` filter is supported to\nreturn only the sessions belonging to the requester when the mode is USER\nand return sessions of all the users when the mode is ADMIN. When no filter\nis sent default to USER mode. NOTE: When the mode is ADMIN, the requester\nshould have `dataplex.environments.listAllSessions` permission to list all\nsessions, in absence of the permission, the request fails.\n\nmode = ADMIN \\| USER\n\n### PageSize\n\n public int PageSize { get; set; }\n\nOptional. Maximum number of sessions to return. The service may return\nfewer than this value. If unspecified, at most 10 sessions will be\nreturned. The maximum value is 1000; values above 1000 will be coerced to\n1000.\n\n### PageToken\n\n public string PageToken { get; set; }\n\nOptional. Page token received from a previous `ListSessions` call. Provide\nthis to retrieve the subsequent page. When paginating, all other parameters\nprovided to `ListSessions` must match the call that provided the page\ntoken.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The resource name of the parent environment:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.\n\n### ParentAsEnvironmentName\n\n public EnvironmentName ParentAsEnvironmentName { get; set; }\n\n[EnvironmentName](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.EnvironmentName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ListSessionsRequest#Google_Cloud_Dataplex_V1_ListSessionsRequest_Parent) resource name property."]]
