Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListSessionsRequest.
List sessions request.
Generated from protobuf messagegoogle.cloud.dataplex.v1.ListSessionsRequest
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 environment:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
↳ page_size
int
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.
↳ page_token
string
Optional. Page token received from a previousListSessionscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListSessionsmust match the call that provided the page token.
↳ filter
string
Optional. Filter request. The followingmodefilter 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 havedataplex.environments.listAllSessionspermission to list all sessions, in absence of the permission, the request fails. mode = ADMIN | USER
getParent
Required. The resource name of the parent environment:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
Returns
Type
Description
string
setParent
Required. The resource name of the parent environment:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
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.
Returns
Type
Description
int
setPageSize
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. Page token received from a previousListSessionscall. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided toListSessionsmust match the call that provided the page
token.
Returns
Type
Description
string
setPageToken
Optional. Page token received from a previousListSessionscall. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided toListSessionsmust match the call that provided the page
token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filter request. The followingmodefilter 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 havedataplex.environments.listAllSessionspermission to list all
sessions, in absence of the permission, the request fails.
mode = ADMIN | USER
Returns
Type
Description
string
setFilter
Optional. Filter request. The followingmodefilter 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 havedataplex.environments.listAllSessionspermission to list all
sessions, in absence of the permission, the request fails.
mode = ADMIN | USER
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The resource name of the parent environment:projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}. Please seeDataplexServiceClient::environmentName()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 ListSessionsRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.ListSessionsRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.ListSessionsRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.ListSessionsRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.ListSessionsRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.ListSessionsRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.ListSessionsRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.ListSessionsRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.ListSessionsRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.ListSessionsRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.ListSessionsRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.ListSessionsRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.ListSessionsRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.ListSessionsRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.ListSessionsRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.ListSessionsRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.ListSessionsRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.ListSessionsRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.ListSessionsRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.ListSessionsRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.ListSessionsRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.ListSessionsRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.ListSessionsRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.ListSessionsRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.ListSessionsRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ListSessionsRequest.\n\nList sessions request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.ListSessionsRequest`\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 environment:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.\n\n### setParent\n\nRequired. The resource name of the parent environment:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.\n\n### getPageSize\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### setPageSize\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### getPageToken\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### setPageToken\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### getFilter\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### setFilter\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### static::build"]]
