Google Cloud Discovery Engine V1 Client - Class ListConversationsRequest (0.7.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
NameDescription
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
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token, received from a previous ListConversations call.

Provide this to retrieve the subsequent page.

Returns
TypeDescription
string

setPageToken

A page token, received from a previous ListConversations call.

Provide this to retrieve the subsequent page.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\DiscoveryEngine\V1\ListConversationsRequest