ydb-php-sdk/protos/Ydb/Topic/DescribeConsumerResult/PartitionConsumerStats.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: protos/ydb_topic.proto

namespace Ydb\Topic\DescribeConsumerResult;

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

/**
 * Generated from protobuf message <code>Ydb.Topic.DescribeConsumerResult.PartitionConsumerStats</code>
 */
class PartitionConsumerStats extends \Google\Protobuf\Internal\Message
{
    /**
     * Last read offset from this partition.
     *
     * Generated from protobuf field <code>int64 last_read_offset = 1;</code>
     */
    protected $last_read_offset = 0;
    /**
     * Committed offset for this partition.
     *
     * Generated from protobuf field <code>int64 committed_offset = 2;</code>
     */
    protected $committed_offset = 0;
    /**
     * Reading this partition read session identifier.
     *
     * Generated from protobuf field <code>string read_session_id = 3;</code>
     */
    protected $read_session_id = '';
    /**
     * Timestamp of providing this partition to this session by server.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp partition_read_session_create_time = 4;</code>
     */
    protected $partition_read_session_create_time = null;
    /**
     * Timestamp of last read from this partition.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp last_read_time = 5;</code>
     */
    protected $last_read_time = null;
    /**
     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_read_time_lag = 6;</code>
     */
    protected $max_read_time_lag = null;
    /**
     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_write_time_lag = 7;</code>
     */
    protected $max_write_time_lag = null;
    /**
     * How much bytes were read during several windows statistics from this partiton.
     *
     * Generated from protobuf field <code>.Ydb.Topic.MultipleWindowsStat bytes_read = 8;</code>
     */
    protected $bytes_read = null;
    /**
     * Read session name, provided by client.
     *
     * Generated from protobuf field <code>string reader_name = 11;</code>
     */
    protected $reader_name = '';
    /**
     * Host where read session connected.
     *
     * Generated from protobuf field <code>int32 connection_node_id = 12;</code>
     */
    protected $connection_node_id = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int|string $last_read_offset
     *           Last read offset from this partition.
     *     @type int|string $committed_offset
     *           Committed offset for this partition.
     *     @type string $read_session_id
     *           Reading this partition read session identifier.
     *     @type \Google\Protobuf\Timestamp $partition_read_session_create_time
     *           Timestamp of providing this partition to this session by server.
     *     @type \Google\Protobuf\Timestamp $last_read_time
     *           Timestamp of last read from this partition.
     *     @type \Google\Protobuf\Duration $max_read_time_lag
     *           Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
     *     @type \Google\Protobuf\Duration $max_write_time_lag
     *           Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
     *     @type \Ydb\Topic\MultipleWindowsStat $bytes_read
     *           How much bytes were read during several windows statistics from this partiton.
     *     @type string $reader_name
     *           Read session name, provided by client.
     *     @type int $connection_node_id
     *           Host where read session connected.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Protos\YdbTopic::initOnce();
        parent::__construct($data);
    }

    /**
     * Last read offset from this partition.
     *
     * Generated from protobuf field <code>int64 last_read_offset = 1;</code>
     * @return int|string
     */
    public function getLastReadOffset()
    {
        return $this->last_read_offset;
    }

    /**
     * Last read offset from this partition.
     *
     * Generated from protobuf field <code>int64 last_read_offset = 1;</code>
     * @param int|string $var
     * @return $this
     */
    public function setLastReadOffset($var)
    {
        GPBUtil::checkInt64($var);
        $this->last_read_offset = $var;

        return $this;
    }

    /**
     * Committed offset for this partition.
     *
     * Generated from protobuf field <code>int64 committed_offset = 2;</code>
     * @return int|string
     */
    public function getCommittedOffset()
    {
        return $this->committed_offset;
    }

    /**
     * Committed offset for this partition.
     *
     * Generated from protobuf field <code>int64 committed_offset = 2;</code>
     * @param int|string $var
     * @return $this
     */
    public function setCommittedOffset($var)
    {
        GPBUtil::checkInt64($var);
        $this->committed_offset = $var;

        return $this;
    }

    /**
     * Reading this partition read session identifier.
     *
     * Generated from protobuf field <code>string read_session_id = 3;</code>
     * @return string
     */
    public function getReadSessionId()
    {
        return $this->read_session_id;
    }

    /**
     * Reading this partition read session identifier.
     *
     * Generated from protobuf field <code>string read_session_id = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setReadSessionId($var)
    {
        GPBUtil::checkString($var, True);
        $this->read_session_id = $var;

        return $this;
    }

    /**
     * Timestamp of providing this partition to this session by server.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp partition_read_session_create_time = 4;</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getPartitionReadSessionCreateTime()
    {
        return $this->partition_read_session_create_time;
    }

    public function hasPartitionReadSessionCreateTime()
    {
        return isset($this->partition_read_session_create_time);
    }

    public function clearPartitionReadSessionCreateTime()
    {
        unset($this->partition_read_session_create_time);
    }

    /**
     * Timestamp of providing this partition to this session by server.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp partition_read_session_create_time = 4;</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setPartitionReadSessionCreateTime($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->partition_read_session_create_time = $var;

        return $this;
    }

    /**
     * Timestamp of last read from this partition.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp last_read_time = 5;</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getLastReadTime()
    {
        return $this->last_read_time;
    }

    public function hasLastReadTime()
    {
        return isset($this->last_read_time);
    }

    public function clearLastReadTime()
    {
        unset($this->last_read_time);
    }

    /**
     * Timestamp of last read from this partition.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp last_read_time = 5;</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setLastReadTime($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->last_read_time = $var;

        return $this;
    }

    /**
     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_read_time_lag = 6;</code>
     * @return \Google\Protobuf\Duration|null
     */
    public function getMaxReadTimeLag()
    {
        return $this->max_read_time_lag;
    }

    public function hasMaxReadTimeLag()
    {
        return isset($this->max_read_time_lag);
    }

    public function clearMaxReadTimeLag()
    {
        unset($this->max_read_time_lag);
    }

    /**
     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_read_time_lag = 6;</code>
     * @param \Google\Protobuf\Duration $var
     * @return $this
     */
    public function setMaxReadTimeLag($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
        $this->max_read_time_lag = $var;

        return $this;
    }

    /**
     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_write_time_lag = 7;</code>
     * @return \Google\Protobuf\Duration|null
     */
    public function getMaxWriteTimeLag()
    {
        return $this->max_write_time_lag;
    }

    public function hasMaxWriteTimeLag()
    {
        return isset($this->max_write_time_lag);
    }

    public function clearMaxWriteTimeLag()
    {
        unset($this->max_write_time_lag);
    }

    /**
     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
     *
     * Generated from protobuf field <code>.google.protobuf.Duration max_write_time_lag = 7;</code>
     * @param \Google\Protobuf\Duration $var
     * @return $this
     */
    public function setMaxWriteTimeLag($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
        $this->max_write_time_lag = $var;

        return $this;
    }

    /**
     * How much bytes were read during several windows statistics from this partiton.
     *
     * Generated from protobuf field <code>.Ydb.Topic.MultipleWindowsStat bytes_read = 8;</code>
     * @return \Ydb\Topic\MultipleWindowsStat|null
     */
    public function getBytesRead()
    {
        return $this->bytes_read;
    }

    public function hasBytesRead()
    {
        return isset($this->bytes_read);
    }

    public function clearBytesRead()
    {
        unset($this->bytes_read);
    }

    /**
     * How much bytes were read during several windows statistics from this partiton.
     *
     * Generated from protobuf field <code>.Ydb.Topic.MultipleWindowsStat bytes_read = 8;</code>
     * @param \Ydb\Topic\MultipleWindowsStat $var
     * @return $this
     */
    public function setBytesRead($var)
    {
        GPBUtil::checkMessage($var, \Ydb\Topic\MultipleWindowsStat::class);
        $this->bytes_read = $var;

        return $this;
    }

    /**
     * Read session name, provided by client.
     *
     * Generated from protobuf field <code>string reader_name = 11;</code>
     * @return string
     */
    public function getReaderName()
    {
        return $this->reader_name;
    }

    /**
     * Read session name, provided by client.
     *
     * Generated from protobuf field <code>string reader_name = 11;</code>
     * @param string $var
     * @return $this
     */
    public function setReaderName($var)
    {
        GPBUtil::checkString($var, True);
        $this->reader_name = $var;

        return $this;
    }

    /**
     * Host where read session connected.
     *
     * Generated from protobuf field <code>int32 connection_node_id = 12;</code>
     * @return int
     */
    public function getConnectionNodeId()
    {
        return $this->connection_node_id;
    }

    /**
     * Host where read session connected.
     *
     * Generated from protobuf field <code>int32 connection_node_id = 12;</code>
     * @param int $var
     * @return $this
     */
    public function setConnectionNodeId($var)
    {
        GPBUtil::checkInt32($var);
        $this->connection_node_id = $var;

        return $this;
    }

}

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