<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/geminidataanalytics/v1beta/data_chat_service.proto

namespace Google\Cloud\GeminiDataAnalytics\V1beta;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * Request for listing chat messages based on parent and conversation_id.
 *
 * Generated from protobuf message <code>google.cloud.geminidataanalytics.v1beta.ListMessagesRequest</code>
 */
class ListMessagesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The conversation to list messages under.
     * Format:
     * `projects/{project}/locations/{location}/conversations/{conversation_id}`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * 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.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. A token identifying a page of results the server should return.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for
     * syntax.
     * ListMessages allows filtering by:
     *  * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`)
     *  * update_time
     *
     * Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';

    /**
     * @param string $parent Required. The conversation to list messages under.
     *                       Format:
     *                       `projects/{project}/locations/{location}/conversations/{conversation_id}`
     *                       Please see {@see DataChatServiceClient::conversationName()} for help formatting this field.
     *
     * @return \Google\Cloud\GeminiDataAnalytics\V1beta\ListMessagesRequest
     *
     * @experimental
     */
    public static function build(string $parent): self
    {
        return (new self())
            ->setParent($parent);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. The conversation to list messages under.
     *           Format:
     *           `projects/{project}/locations/{location}/conversations/{conversation_id}`
     *     @type int $page_size
     *           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.
     *     @type string $page_token
     *           Optional. A token identifying a page of results the server should return.
     *     @type string $filter
     *           Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for
     *           syntax.
     *           ListMessages allows filtering by:
     *            * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`)
     *            * update_time
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Geminidataanalytics\V1Beta\DataChatService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The conversation to list messages under.
     * Format:
     * `projects/{project}/locations/{location}/conversations/{conversation_id}`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Required. The conversation to list messages under.
     * Format:
     * `projects/{project}/locations/{location}/conversations/{conversation_id}`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setParent($var)
    {
        GPBUtil::checkString($var, True);
        $this->parent = $var;

        return $this;
    }

    /**
     * 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.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * 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.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * Optional. A token identifying a page of results the server should return.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Optional. A token identifying a page of results the server should return.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for
     * syntax.
     * ListMessages allows filtering by:
     *  * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`)
     *  * update_time
     *
     * Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for
     * syntax.
     * ListMessages allows filtering by:
     *  * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`)
     *  * update_time
     *
     * Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

}

