ydb-php-sdk/protos/Ydb/Table/Changefeed.php

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

namespace Ydb\Table;

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

/**
 * Generated from protobuf message <code>Ydb.Table.Changefeed</code>
 */
class Changefeed extends \Google\Protobuf\Internal\Message
{
    /**
     * Name of the feed
     *
     * Generated from protobuf field <code>string name = 1;</code>
     */
    protected $name = '';
    /**
     * Mode specifies the information that will be written to the feed
     *
     * Generated from protobuf field <code>.Ydb.Table.ChangefeedMode.Mode mode = 2;</code>
     */
    protected $mode = 0;
    /**
     * Format of the data
     *
     * Generated from protobuf field <code>.Ydb.Table.ChangefeedFormat.Format format = 3;</code>
     */
    protected $format = 0;
    /**
     * How long data in changefeed's underlying topic should be stored
     *
     * Generated from protobuf field <code>.google.protobuf.Duration retention_period = 4;</code>
     */
    protected $retention_period = null;
    /**
     * Emit virtual timestamps of changes along with data or not
     *
     * Generated from protobuf field <code>bool virtual_timestamps = 5;</code>
     */
    protected $virtual_timestamps = false;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Name of the feed
     *     @type int $mode
     *           Mode specifies the information that will be written to the feed
     *     @type int $format
     *           Format of the data
     *     @type \Google\Protobuf\Duration $retention_period
     *           How long data in changefeed's underlying topic should be stored
     *     @type bool $virtual_timestamps
     *           Emit virtual timestamps of changes along with data or not
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Protos\YdbTable::initOnce();
        parent::__construct($data);
    }

    /**
     * Name of the feed
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Name of the feed
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Mode specifies the information that will be written to the feed
     *
     * Generated from protobuf field <code>.Ydb.Table.ChangefeedMode.Mode mode = 2;</code>
     * @return int
     */
    public function getMode()
    {
        return $this->mode;
    }

    /**
     * Mode specifies the information that will be written to the feed
     *
     * Generated from protobuf field <code>.Ydb.Table.ChangefeedMode.Mode mode = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setMode($var)
    {
        GPBUtil::checkEnum($var, \Ydb\Table\ChangefeedMode\Mode::class);
        $this->mode = $var;

        return $this;
    }

    /**
     * Format of the data
     *
     * Generated from protobuf field <code>.Ydb.Table.ChangefeedFormat.Format format = 3;</code>
     * @return int
     */
    public function getFormat()
    {
        return $this->format;
    }

    /**
     * Format of the data
     *
     * Generated from protobuf field <code>.Ydb.Table.ChangefeedFormat.Format format = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setFormat($var)
    {
        GPBUtil::checkEnum($var, \Ydb\Table\ChangefeedFormat\Format::class);
        $this->format = $var;

        return $this;
    }

    /**
     * How long data in changefeed's underlying topic should be stored
     *
     * Generated from protobuf field <code>.google.protobuf.Duration retention_period = 4;</code>
     * @return \Google\Protobuf\Duration|null
     */
    public function getRetentionPeriod()
    {
        return $this->retention_period;
    }

    public function hasRetentionPeriod()
    {
        return isset($this->retention_period);
    }

    public function clearRetentionPeriod()
    {
        unset($this->retention_period);
    }

    /**
     * How long data in changefeed's underlying topic should be stored
     *
     * Generated from protobuf field <code>.google.protobuf.Duration retention_period = 4;</code>
     * @param \Google\Protobuf\Duration $var
     * @return $this
     */
    public function setRetentionPeriod($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
        $this->retention_period = $var;

        return $this;
    }

    /**
     * Emit virtual timestamps of changes along with data or not
     *
     * Generated from protobuf field <code>bool virtual_timestamps = 5;</code>
     * @return bool
     */
    public function getVirtualTimestamps()
    {
        return $this->virtual_timestamps;
    }

    /**
     * Emit virtual timestamps of changes along with data or not
     *
     * Generated from protobuf field <code>bool virtual_timestamps = 5;</code>
     * @param bool $var
     * @return $this
     */
    public function setVirtualTimestamps($var)
    {
        GPBUtil::checkBool($var);
        $this->virtual_timestamps = $var;

        return $this;
    }

}