Google Cloud Contact Center Insights V1 Client - Class ListConversationsRequest (1.5.0)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class ListConversationsRequest.

Request to list conversations.

Generated from protobuf message google.cloud.contactcenterinsights.v1.ListConversationsRequest

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource of the conversation.

↳ page_size int

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

↳ page_token string

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

↳ filter string

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

↳ view int

The level of details of the conversation. Default is BASIC.

getParent

Required. The parent resource of the conversation.

Returns
TypeDescription
string

setParent

Required. The parent resource of the conversation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

Returns
TypeDescription
int

setPageSize

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

Returns
TypeDescription
string

setPageToken

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Returns
TypeDescription
string

setFilter

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getView

The level of details of the conversation. Default is BASIC.

Returns
TypeDescription
int

setView

The level of details of the conversation. Default is BASIC.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The parent resource of the conversation. Please see Google\Cloud\ContactCenterInsights\V1\ContactCenterInsightsClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\ContactCenterInsights\V1\ListConversationsRequest