ListSessionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request for ListSessions method.
Attributes |
|
|---|---|
| Name | Description |
parent |
str
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 |
str
A page token, received from a previous ListSessions
call. Provide this to retrieve the subsequent page.
|
filter |
str
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
- collaborative_project
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"
- collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"
|
order_by |
str
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
- display_name
Example:
- update_time desc
- create_time
- is_pinned desc,update_time desc: list sessions by
is_pinned first, then by update_time.
|