Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ListConversationsRequest.
The request message for Conversations.ListConversations .
Generated from protobuf message google.cloud.dialogflow.v2.ListConversationsRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>
.
↳ page_size
int
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
↳ page_token
string
Optional. The next_page_token value returned from a previous list request.
↳ filter
string
A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:
- The value must be a string, a number, or a boolean.
- The comparison operator must be either
=
,!=
,>
, or<
. - To filter on multiple expressions, separate the expressions with
AND
orOR
(omitting both impliesAND
). - For clarity, expressions can be enclosed in parentheses.
lifecycle_state
can be filtered on in this way. For example, the following expression only returns COMPLETED
conversations: lifecycle_state = "COMPLETED"
For more information about filtering, see API Filtering
.getParent
Required. The project from which to list all conversation.
Format: projects/<Project ID>/locations/<Location ID>
.
string
setParent
Required. The project from which to list all conversation.
Format: projects/<Project ID>/locations/<Location ID>
.
var
string
$this
getPageSize
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
int
setPageSize
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
var
int
$this
getPageToken
Optional. The next_page_token value returned from a previous list request.
string
setPageToken
Optional. The next_page_token value returned from a previous list request.
var
string
$this
getFilter
A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:
- The value must be a string, a number, or a boolean.
- The comparison operator must be either
=
,!=
,>
, or<
. - To filter on multiple expressions, separate the
expressions with
AND
orOR
(omitting both impliesAND
). - For clarity, expressions can be enclosed in parentheses.
lifecycle_state
can be filtered on in this way. For example,
the following expression only returns COMPLETED
conversations: lifecycle_state = "COMPLETED"
For more information about filtering, see API Filtering
.string
setFilter
A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:
- The value must be a string, a number, or a boolean.
- The comparison operator must be either
=
,!=
,>
, or<
. - To filter on multiple expressions, separate the
expressions with
AND
orOR
(omitting both impliesAND
). - For clarity, expressions can be enclosed in parentheses.
lifecycle_state
can be filtered on in this way. For example,
the following expression only returns COMPLETED
conversations: lifecycle_state = "COMPLETED"
For more information about filtering, see API Filtering
.var
string
$this