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 \ V1Methods
__construct
Constructor.
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}
string
setParent
Required. The resource name of the location to list sessions from.
Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
var
string
$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.
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.
var
int
$this
getPageToken
Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
string
setPageToken
Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
var
string
$this
getFilter
Optional. The standard list filter.
Supported fields:
-
display_name -
user_id -
labelsExample:display_name="abc",user_id="123",labels.key="value".
string
setFilter
Optional. The standard list filter.
Supported fields:
-
display_name -
user_id -
labelsExample:display_name="abc",user_id="123",labels.key="value".
var
string
$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_timeExample:create_time desc.
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_timeExample:create_time desc.
var
string
$this
static::build
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.
