Google Cloud Ai Platform V1 Client - Class ListSessionsRequest (1.52.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListSessionsRequest.

Request message for SessionService.ListSessions.

Generated from protobuf message google.cloud.aiplatform.v1.ListSessionsRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

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

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 string

Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
↳ filter 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 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.

getParent

Required. The resource name of the location to list sessions from.

Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Returns
Type Description
string

setParent

Required. The resource name of the location to list sessions from.

Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.

Returns
Type Description
string

setPageToken

Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. The standard list filter.

Supported fields:

  • display_name
  • user_id
  • labels Example: display_name="abc", user_id="123", labels.key="value".
Returns
Type Description
string

setFilter

Optional. The standard list filter.

Supported fields:

  • display_name
  • user_id
  • labels Example: display_name="abc", user_id="123", labels.key="value".
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

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
Type Description
string

setOrderBy

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.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the location to list sessions from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} Please see SessionServiceClient::reasoningEngineName() for help formatting this field.
Returns
Type Description
ListSessionsRequest