protos/Ydb/Topic/StreamReadMessage/InitRequest/TopicReadSettings.php - main - githubmirror/ydb-php-sdk

protos/Ydb/Topic/StreamReadMessage/InitRequest/TopicReadSettings.php
201 строка6 KB
Alexei Shabalin
updated protos
17 фев 2023, 13:31
17 фев 2023, 13:31ae6a264
<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: protos/ydb_topic.proto

namespace Ydb\Topic\StreamReadMessage\InitRequest;

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

/**
 * Generated from protobuf message <code>Ydb.Topic.StreamReadMessage.InitRequest.TopicReadSettings</code>
 */
class TopicReadSettings extends \Google\Protobuf\Internal\Message
{
    /**
     * Topic path.
     *
     * Generated from protobuf field <code>string path = 1;</code>
     */
    protected $path = '';
    /**
     * Partitions that will be read by this session.
     * If list is empty - then session will read all partitions.
     *
     * Generated from protobuf field <code>repeated int64 partition_ids = 2;</code>
     */
    private $partition_ids;
    /**
     * Skip all messages that has write timestamp smaller than now - max_lag.
     * Zero means infinite lag.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_lag = 3;</code>
     */
    protected $max_lag = null;
    /**
     * Read data only after this timestamp from this topic.
     * Read only messages with 'written_at' value greater or equal than this timestamp.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp read_from = 4;</code>
     */
    protected $read_from = null;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $path
     *           Topic path.
     *     @type array<int>|array<string>|\Google\Protobuf\Internal\RepeatedField $partition_ids
     *           Partitions that will be read by this session.
     *           If list is empty - then session will read all partitions.
     *     @type \Google\Protobuf\Duration $max_lag
     *           Skip all messages that has write timestamp smaller than now - max_lag.
     *           Zero means infinite lag.
     *     @type \Google\Protobuf\Timestamp $read_from
     *           Read data only after this timestamp from this topic.
     *           Read only messages with 'written_at' value greater or equal than this timestamp.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Protos\YdbTopic::initOnce();
        parent::__construct($data);
    }

    /**
     * Topic path.
     *
     * Generated from protobuf field <code>string path = 1;</code>
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Topic path.
     *
     * Generated from protobuf field <code>string path = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setPath($var)
    {
        GPBUtil::checkString($var, True);
        $this->path = $var;

        return $this;
    }

    /**
     * Partitions that will be read by this session.
     * If list is empty - then session will read all partitions.
     *
     * Generated from protobuf field <code>repeated int64 partition_ids = 2;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getPartitionIds()
    {
        return $this->partition_ids;
    }

    /**
     * Partitions that will be read by this session.
     * If list is empty - then session will read all partitions.
     *
     * Generated from protobuf field <code>repeated int64 partition_ids = 2;</code>
     * @param array<int>|array<string>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setPartitionIds($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
        $this->partition_ids = $arr;

        return $this;
    }

    /**
     * Skip all messages that has write timestamp smaller than now - max_lag.
     * Zero means infinite lag.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_lag = 3;</code>
     * @return \Google\Protobuf\Duration|null
     */
    public function getMaxLag()
    {
        return $this->max_lag;
    }

    public function hasMaxLag()
    {
        return isset($this->max_lag);
    }

    public function clearMaxLag()
    {
        unset($this->max_lag);
    }

    /**
     * Skip all messages that has write timestamp smaller than now - max_lag.
     * Zero means infinite lag.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_lag = 3;</code>
     * @param \Google\Protobuf\Duration $var
     * @return $this
     */
    public function setMaxLag($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
        $this->max_lag = $var;

        return $this;
    }

    /**
     * Read data only after this timestamp from this topic.
     * Read only messages with 'written_at' value greater or equal than this timestamp.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp read_from = 4;</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getReadFrom()
    {
        return $this->read_from;
    }

    public function hasReadFrom()
    {
        return isset($this->read_from);
    }

    public function clearReadFrom()
    {
        unset($this->read_from);
    }

    /**
     * Read data only after this timestamp from this topic.
     * Read only messages with 'written_at' value greater or equal than this timestamp.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp read_from = 4;</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setReadFrom($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->read_from = $var;

        return $this;
    }

}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TopicReadSettings::class, \Ydb\Topic\StreamReadMessage_InitRequest_TopicReadSettings::class);