Google Cloud Discovery Engine V1 Client - Class ListSessionsRequest (1.8.0)

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.

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""

Returns
Type	Description
`string`

setFilter