Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListConversationsRequest.
Request for ListConversations method.
Generated from protobuf message google.cloud.discoveryengine.v1.ListConversationsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}
↳ page_size
int
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
↳ page_token
string
A page token, received from a previous ListConversations
call. Provide this to retrieve the subsequent page.
↳ filter
string
A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
↳ order_by
string
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
* conversation_name
Example: "update_time desc" "create_time"
getParent
Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}
string
setParent
Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}
var
string
$this
getPageSize
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
int
setPageSize
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
var
int
$this
getPageToken
A page token, received from a previous ListConversations
call.
Provide this to retrieve the subsequent page.
string
setPageToken
A page token, received from a previous ListConversations
call.
Provide this to retrieve the subsequent page.
var
string
$this
getFilter
A filter to apply on the list results. The supported features are: user_pseudo_id, state.
Example: "user_pseudo_id = some_id"
string
setFilter
A filter to apply on the list results. The supported features are: user_pseudo_id, state.
Example: "user_pseudo_id = some_id"
var
string
$this
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 -
conversation_nameExample: "update_time desc" "create_time"
string
setOrderBy
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 -
conversation_nameExample: "update_time desc" "create_time"
var
string
$this
static::build
parent
string
Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}
Please see Google\Cloud\DiscoveryEngine\V1\ConversationalSearchServiceClient::dataStoreName()
for help formatting this field.
