Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListSessionsRequest.
A request to list sessions in a project.
Generated from protobuf messagegoogle.cloud.dataproc.v1.ListSessionsRequest
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent, which owns this collection of sessions.
↳ page_size
int
Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
↳ page_token
string
Optional. A page token received from a previousListSessionscall. Provide this token to retrieve the subsequent page.
↳ filter
string
Optional. A filter for the sessions to return in the response. A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields aresession_id,session_uuid,state, andcreate_time. Example:state = ACTIVE and create_time < "2023-01-01T00:00:00Z"is a filter for sessions in an ACTIVE state that were created before 2023-01-01. Seehttps://google.aip.dev/assets/misc/ebnf-filtering.txtfor a detailed description of the filter syntax and a list of supported comparators.
getParent
Required. The parent, which owns this collection of sessions.
Returns
Type
Description
string
setParent
Required. The parent, which owns this collection of sessions.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of sessions to return in each response.
The service may return fewer than this value.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of sessions to return in each response.
The service may return fewer than this value.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token received from a previousListSessionscall.
Provide this token to retrieve the subsequent page.
Returns
Type
Description
string
setPageToken
Optional. A page token received from a previousListSessionscall.
Provide this token to retrieve the subsequent page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. A filter for the sessions to return in the response.
A filter is a logical expression constraining the values of various fields
in each session resource. Filters are case sensitive, and may contain
multiple clauses combined with logical operators (AND, OR).
Supported fields aresession_id,session_uuid,state, andcreate_time.
Example:state = ACTIVE and create_time < "2023-01-01T00:00:00Z"is a filter for sessions in an ACTIVE state that were created before
2023-01-01.
Seehttps://google.aip.dev/assets/misc/ebnf-filtering.txtfor a detailed
description of the filter syntax and a list of supported comparators.
Returns
Type
Description
string
setFilter
Optional. A filter for the sessions to return in the response.
A filter is a logical expression constraining the values of various fields
in each session resource. Filters are case sensitive, and may contain
multiple clauses combined with logical operators (AND, OR).
Supported fields aresession_id,session_uuid,state, andcreate_time.
Example:state = ACTIVE and create_time < "2023-01-01T00:00:00Z"is a filter for sessions in an ACTIVE state that were created before
2023-01-01.
Seehttps://google.aip.dev/assets/misc/ebnf-filtering.txtfor a detailed
description of the filter syntax and a list of supported comparators.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent, which owns this collection of sessions. Please seeGoogle\Cloud\Dataproc\V1\SessionControllerClient::locationName()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 Dataproc V1 Client - Class ListSessionsRequest (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.ListSessionsRequest)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.ListSessionsRequest)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.ListSessionsRequest)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.ListSessionsRequest)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.ListSessionsRequest)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.ListSessionsRequest)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.ListSessionsRequest)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.ListSessionsRequest)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.ListSessionsRequest)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.ListSessionsRequest)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.ListSessionsRequest)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.ListSessionsRequest)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.ListSessionsRequest)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.ListSessionsRequest)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.ListSessionsRequest)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.ListSessionsRequest)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.ListSessionsRequest)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.ListSessionsRequest)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.ListSessionsRequest) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class ListSessionsRequest.\n\nA request to list sessions in a project.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.ListSessionsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent, which owns this collection of sessions.\n\n### setParent\n\nRequired. The parent, which owns this collection of sessions.\n\n### getPageSize\n\nOptional. The maximum number of sessions to return in each response.\n\nThe service may return fewer than this value.\n\n### setPageSize\n\nOptional. The maximum number of sessions to return in each response.\n\nThe service may return fewer than this value.\n\n### getPageToken\n\nOptional. A page token received from a previous `ListSessions` call.\n\nProvide this token to retrieve the subsequent page.\n\n### setPageToken\n\nOptional. A page token received from a previous `ListSessions` call.\n\nProvide this token to retrieve the subsequent page.\n\n### getFilter\n\nOptional. A filter for the sessions to return in the response.\n\nA filter is a logical expression constraining the values of various fields\nin each session resource. Filters are case sensitive, and may contain\nmultiple clauses combined with logical operators (AND, OR).\nSupported fields are `session_id`, `session_uuid`, `state`, and\n`create_time`.\nExample: `state = ACTIVE and create_time \u003c \"2023-01-01T00:00:00Z\"`\nis a filter for sessions in an ACTIVE state that were created before\n2023-01-01.\nSee \u003chttps://google.aip.dev/assets/misc/ebnf-filtering.txt\u003e for a detailed\ndescription of the filter syntax and a list of supported comparators.\n\n### setFilter\n\nOptional. A filter for the sessions to return in the response.\n\nA filter is a logical expression constraining the values of various fields\nin each session resource. Filters are case sensitive, and may contain\nmultiple clauses combined with logical operators (AND, OR).\nSupported fields are `session_id`, `session_uuid`, `state`, and\n`create_time`.\nExample: `state = ACTIVE and create_time \u003c \"2023-01-01T00:00:00Z\"`\nis a filter for sessions in an ACTIVE state that were created before\n2023-01-01.\nSee \u003chttps://google.aip.dev/assets/misc/ebnf-filtering.txt\u003e for a detailed\ndescription of the filter syntax and a list of supported comparators.\n\n### static::build"]]
