Discovery Engine v1 API - Class ListSessionsRequest (1.10.0) 

public sealed class ListSessionsRequest : IMessage<ListSessionsRequest>, IEquatable<ListSessionsRequest>, IDeepCloneable<ListSessionsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Discovery Engine v1 API class ListSessionsRequest.

Request for ListSessions method.

Inheritance

object > ListSessionsRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ListSessionsRequest()

public ListSessionsRequest()

ListSessionsRequest(ListSessionsRequest)

public ListSessionsRequest(ListSessionsRequest other)
Parameter
Name Description
other ListSessionsRequest

Properties

Filter

public string Filter { get; set; }

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

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

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.
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token, received from a previous ListSessions call. Provide this to retrieve the subsequent page.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

Property Value
Type Description
string

ParentAsDataStoreName

public DataStoreName ParentAsDataStoreName { get; set; }

DataStoreName-typed view over the Parent resource name property.

Property Value
Type Description
DataStoreName