Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListSessionsRequest.
Request for ListSessions method.
Generated from protobuf message google.cloud.discoveryengine.v1.ListSessionsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
↳ page_size
int
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
↳ page_token
string
A page token, received from a previous ListSessions call. Provide this to retrieve the subsequent page.
↳ filter
string
A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * * user_pseudo_id * * state * * display_name * * starred * * is_pinned * * labels * * create_time * * update_time Examples: "user_pseudo_id = some_id" "display_name = "some_name"" "starred = true" "is_pinned=true AND (NOT labels:hidden)" "create_time > "1970-01-01T12:00:00Z""
↳ order_by
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * * update_time * * create_time * * session_name * * is_pinned Example: * * "update_time desc" * * "create_time" * * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_time.
getParent
Required. The data store resource name. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
Returns
Type
Description
string
setParent
Required. The data store resource name. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Maximum number of results to return. If unspecified, defaults
to 50. Max allowed value is 1000.
Returns
Type
Description
int
setPageSize
Maximum number of results to return. If unspecified, defaults
to 50. Max allowed value is 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A page token, received from a previous ListSessions call.
Provide this to retrieve the subsequent page.
Returns
Type
Description
string
setPageToken
A page token, received from a previous ListSessions call.
Provide this to retrieve the subsequent page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
A comma-separated list of fields to filter by, in EBNF grammar.
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending.
Supported fields:
update_time
create_time
session_name
is_pinned
Example:
"update_time desc"
"create_time"
"is_pinned desc,update_time desc": list sessions by is_pinned first, then
by update_time.
Returns
Type
Description
string
setOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending.
Supported fields:
update_time
create_time
session_name
is_pinned
Example:
"update_time desc"
"create_time"
"is_pinned desc,update_time desc": list sessions by is_pinned first, then
by update_time.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The data store resource name. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
Please see ConversationalSearchServiceClient::dataStoreName() 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 Discovery Engine V1 Client - Class ListSessionsRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.ListSessionsRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.ListSessionsRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.ListSessionsRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.ListSessionsRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.ListSessionsRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.ListSessionsRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.ListSessionsRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.ListSessionsRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.ListSessionsRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.ListSessionsRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.ListSessionsRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.ListSessionsRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.ListSessionsRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.ListSessionsRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.ListSessionsRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.ListSessionsRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.ListSessionsRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListSessionsRequest.\n\nRequest for ListSessions method.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.ListSessionsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The data store resource name. Format:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`\n\n### setParent\n\nRequired. The data store resource name. Format:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`\n\n### getPageSize\n\nMaximum number of results to return. If unspecified, defaults\nto 50. Max allowed value is 1000.\n\n### setPageSize\n\nMaximum number of results to return. If unspecified, defaults\nto 50. Max allowed value is 1000.\n\n### getPageToken\n\nA page token, received from a previous `ListSessions` call.\n\nProvide this to retrieve the subsequent page.\n\n### setPageToken\n\nA page token, received from a previous `ListSessions` call.\n\nProvide this to retrieve the subsequent page.\n\n### getFilter\n\nA comma-separated list of fields to filter by, in EBNF grammar.\n\nThe supported fields are:\n\n- `user_pseudo_id`\n- `state`\n- `display_name`\n- `starred`\n- `is_pinned`\n- `labels`\n- `create_time`\n- `update_time` Examples: \"user_pseudo_id = some_id\" \"display_name = \"some_name\"\" \"starred = true\" \"is_pinned=true AND (NOT labels:hidden)\" \"create_time \\\u003e \"1970-01-01T12:00:00Z\"\"\n\n### setFilter\n\nA comma-separated list of fields to filter by, in EBNF grammar.\n\nThe supported fields are:\n\n- `user_pseudo_id`\n- `state`\n- `display_name`\n- `starred`\n- `is_pinned`\n- `labels`\n- `create_time`\n- `update_time` Examples: \"user_pseudo_id = some_id\" \"display_name = \"some_name\"\" \"starred = true\" \"is_pinned=true AND (NOT labels:hidden)\" \"create_time \\\u003e \"1970-01-01T12:00:00Z\"\"\n\n### getOrderBy\n\nA comma-separated list of fields to order by, sorted in ascending order.\n\nUse \"desc\" after a field name for descending.\nSupported fields:\n\n- `update_time`\n- `create_time`\n- `session_name`\n- `is_pinned` Example:\n - \"update_time desc\"\n - \"create_time\"\n - \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.\n\n### setOrderBy\n\nA comma-separated list of fields to order by, sorted in ascending order.\n\nUse \"desc\" after a field name for descending.\nSupported fields:\n\n- `update_time`\n- `create_time`\n- `session_name`\n- `is_pinned` Example:\n - \"update_time desc\"\n - \"create_time\"\n - \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.\n\n### static::build"]]
