Google Cloud Ces V1 Client - Class ListConversationsRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class ListConversationsRequest.

Request message for AgentService.ListConversations .

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

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The resource name of the app to list conversations from.

↳ page_size
int

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

↳ page_token
string

Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.

↳ filter
string

Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.

↳ source
int

Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of sources field.

↳ sources
array

Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.

getParent

Required. The resource name of the app to list conversations from.

Returns
Type
Description
string

setParent

Required. The resource name of the app to list conversations from.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
Type
Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.

Returns
Type
Description
string

setPageToken

Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

Optional. Filter to be applied when listing the conversations.

See https://google.aip.dev/160 for more details.

Returns
Type
Description
string

setFilter

Optional. Filter to be applied when listing the conversations.

See https://google.aip.dev/160 for more details.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSource

Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of sources field.

Returns
Type
Description
int
Enum of type Source .

setSource

Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of sources field.

Parameter
Name
Description
var
int

Enum of type Source .

Returns
Type
Description
$this

getSources

Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.

Returns
Type
Description

setSources

Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.

Parameter
Name
Description
var
int[]
Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

Required. The resource name of the app to list conversations from. Please see AgentServiceClient::appName() for help formatting this field.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: