Google Cloud Discovery Engine V1 Client - Class ListConversationsRequest (0.7.1)

Version 0.7.1

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

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

Methods

__construct

Constructor.

Parameters
Name	Description
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}

Returns
Type	Description
string

setParent

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

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

Returns
Type	Description
int

setPageSize

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

A page token, received from a previous ListConversations call.

Provide this to retrieve the subsequent page.

Returns
Type	Description
string

setPageToken

A page token, received from a previous ListConversations call.

Provide this to retrieve the subsequent page.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

Returns
Type	Description
string

setFilter

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

Parameter
Name	Description
var	string

Returns
Type	Description
$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_name Example: "update_time desc" "create_time"

Returns
Type	Description
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_name Example: "update_time desc" "create_time"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
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.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1\ListConversationsRequest