com.google.cloud.discoveryengine.v1

Interface ListSessionsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListSessionsRequest, ListSessionsRequest.Builder

@Generated
public interface ListSessionsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() A comma-separated list of fields to filter by, in EBNF grammar.
com.google.protobuf.ByteString	getFilterBytes() A comma-separated list of fields to filter by, in EBNF grammar.
String	getOrderBy() A comma-separated list of fields to order by, sorted in ascending order.
com.google.protobuf.ByteString	getOrderByBytes() A comma-separated list of fields to order by, sorted in ascending order.
int	getPageSize() Maximum number of results to return.
String	getPageToken() A page token, received from a previous `ListSessions` call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token, received from a previous `ListSessions` call.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

int getPageSize()

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

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

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

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

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

string page_token = 3;

Returns:

The bytes for pageToken.

getFilter

String getFilter()

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

string filter = 4;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

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

string filter = 4;

Returns:

The bytes for filter.

getOrderBy

String getOrderBy()

 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.
 

string order_by = 5;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 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.
 

string order_by = 5;

Returns:

The bytes for orderBy.