Vertex AI v1 API - Class ListSessionsRequest (3.66.0) 

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

Reference documentation and code samples for the Vertex AI v1 API class ListSessionsRequest.

Request message for [SessionService.ListSessions][google.cloud.aiplatform.v1.SessionService.ListSessions].

Inheritance

object > ListSessionsRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListSessionsRequest()

public ListSessionsRequest()

ListSessionsRequest(ListSessionsRequest)

public ListSessionsRequest(ListSessionsRequest other)
Parameter
Name Description
other ListSessionsRequest

Properties

Filter

public string Filter { get; set; }

Optional. The standard list filter. Supported fields:

  • display_name
  • user_id
  • labels

Example: display_name="abc", user_id="123", labels.key="value".

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • create_time
  • update_time

Example: create_time desc.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The [next_page_token][google.cloud.aiplatform.v1.ListSessionsResponse.next_page_token] value returned from a previous list [SessionService.ListSessions][google.cloud.aiplatform.v1.SessionService.ListSessions] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the location to list sessions from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Property Value
Type Description
string

ParentAsReasoningEngineName

public ReasoningEngineName ParentAsReasoningEngineName { get; set; }

ReasoningEngineName-typed view over the Parent resource name property.

Property Value
Type Description
ReasoningEngineName