Google Cloud Dialogflow V2 Client - Class ListMessagesRequest (1.15.1)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ListMessagesRequest.

The request message for Conversations.ListMessages.

Generated from protobuf message google.cloud.dialogflow.v2.ListMessagesRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The name of the conversation to list messages for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`
`↳ filter`	`string` Optional. Filter on message fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds > 1551790877964485` or `create_time > 2017-01-15T01:30:15.01Z`. For more information about filtering, see API Filtering.
`↳ 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.

getParent

Required. The name of the conversation to list messages for.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>

Returns
Type	Description
`string`

setParent

Required. The name of the conversation to list messages for.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Filter on message fields. Currently predicates on create_time and create_time_epoch_microseconds are supported. create_time only support milliseconds accuracy. E.g., create_time_epoch_microseconds > 1551790877964485 or create_time > 2017-01-15T01:30:15.01Z.

For more information about filtering, see API Filtering.

Returns
Type	Description
`string`

setFilter

For more information about filtering, see API Filtering.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. The next_page_token value returned from a previous list request.

Returns
Type	Description
`string`

setPageToken

Optional. The next_page_token value returned from a previous list request.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The name of the conversation to list messages for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>` Please see Google\Cloud\Dialogflow\V2\ConversationsClient::conversationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\ListMessagesRequest`