Google Cloud Gemini Data Analytics V1beta Client - Class ListMessagesRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class ListMessagesRequest.

Request for listing chat messages based on parent and conversation_id.

Generated from protobuf message google.cloud.geminidataanalytics.v1beta.ListMessagesRequest

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The conversation to list messages under. Format: projects/{project}/locations/{location}/conversations/{conversation_id}

↳ page_size int

Optional. Requested page size. Server may return fewer items than requested. The max page size is 100. All larger page sizes will be coerced to 100. If unspecified, server will pick 50 as an approperiate default.

↳ page_token string

Optional. A token identifying a page of results the server should return.

↳ filter string

Optional. Filtering results. See AIP-160 for syntax. ListMessages allows filtering by: * * create_time (e.g., createTime > "2025-01-28T06:51:56-08:00") * * update_time

getParent

Required. The conversation to list messages under.

Format: projects/{project}/locations/{location}/conversations/{conversation_id}

Returns
Type Description
string

setParent

Required. The conversation to list messages under.

Format: projects/{project}/locations/{location}/conversations/{conversation_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. The max page size is 100. All larger page sizes will be coerced to 100. If unspecified, server will pick 50 as an approperiate default.

Returns
Type Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. The max page size is 100. All larger page sizes will be coerced to 100. If unspecified, server will pick 50 as an approperiate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A token identifying a page of results the server should return.

Returns
Type Description
string

setPageToken

Optional. A token identifying a page of results the server should return.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filtering results. See AIP-160 for syntax.

ListMessages allows filtering by:

  • create_time (e.g., createTime > "2025-01-28T06:51:56-08:00")
  • update_time
Returns
Type Description
string

setFilter

Optional. Filtering results. See AIP-160 for syntax.

ListMessages allows filtering by:

  • create_time (e.g., createTime > "2025-01-28T06:51:56-08:00")
  • update_time
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The conversation to list messages under. Format: projects/{project}/locations/{location}/conversations/{conversation_id} Please see DataChatServiceClient::conversationName() for help formatting this field.

Returns
Type Description
ListMessagesRequest