Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListSessionsRequest (v1.40.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListSessionsRequest.

Request message for SessionService.ListSessions.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. The standard list filter. Supported fields:

    • display_name
    • user_id
    • labels

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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. The standard list filter. Supported fields:

    • display_name
    • user_id
    • labels

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

Returns
  • (::String) — Optional. The standard list filter. Supported fields:

    • display_name
    • user_id
    • labels

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

#order_by

def order_by() -> ::String
Returns
  • (::String) — 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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the location to list sessions from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the location to list sessions from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
Returns
  • (::String) — Required. The resource name of the location to list sessions from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}