ydb-php-sdk/protos/Ydb/Table/ColumnFamily.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.ColumnFamily</code>
 */
class ColumnFamily extends \Google\Protobuf\Internal\Message
{
    /**
     * Name of the column family, the name "default" must be used for the
     * primary column family that contains at least primary key columns
     *
     * Generated from protobuf field <code>string name = 1;</code>
     */
    protected $name = '';
    /**
     * This specifies data storage settings for column family
     *
     * Generated from protobuf field <code>.Ydb.Table.StoragePool data = 2;</code>
     */
    protected $data = null;
    /**
     * Optionally specify how data should be compressed
     *
     * Generated from protobuf field <code>.Ydb.Table.ColumnFamily.Compression compression = 3;</code>
     */
    protected $compression = 0;
    /**
     * When enabled table data will be kept in memory
     * WARNING: DO NOT USE
     *
     * Generated from protobuf field <code>.Ydb.FeatureFlag.Status keep_in_memory = 4;</code>
     */
    protected $keep_in_memory = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Name of the column family, the name "default" must be used for the
     *           primary column family that contains at least primary key columns
     *     @type \Ydb\Table\StoragePool $data
     *           This specifies data storage settings for column family
     *     @type int $compression
     *           Optionally specify how data should be compressed
     *     @type int $keep_in_memory
     *           When enabled table data will be kept in memory
     *           WARNING: DO NOT USE
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Protos\YdbTable::initOnce();
        parent::__construct($data);
    }

    /**
     * Name of the column family, the name "default" must be used for the
     * primary column family that contains at least primary key columns
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Name of the column family, the name "default" must be used for the
     * primary column family that contains at least primary key columns
     *
     * 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;
    }

    /**
     * This specifies data storage settings for column family
     *
     * Generated from protobuf field <code>.Ydb.Table.StoragePool data = 2;</code>
     * @return \Ydb\Table\StoragePool|null
     */
    public function getData()
    {
        return $this->data;
    }

    public function hasData()
    {
        return isset($this->data);
    }

    public function clearData()
    {
        unset($this->data);
    }

    /**
     * This specifies data storage settings for column family
     *
     * Generated from protobuf field <code>.Ydb.Table.StoragePool data = 2;</code>
     * @param \Ydb\Table\StoragePool $var
     * @return $this
     */
    public function setData($var)
    {
        GPBUtil::checkMessage($var, \Ydb\Table\StoragePool::class);
        $this->data = $var;

        return $this;
    }

    /**
     * Optionally specify how data should be compressed
     *
     * Generated from protobuf field <code>.Ydb.Table.ColumnFamily.Compression compression = 3;</code>
     * @return int
     */
    public function getCompression()
    {
        return $this->compression;
    }

    /**
     * Optionally specify how data should be compressed
     *
     * Generated from protobuf field <code>.Ydb.Table.ColumnFamily.Compression compression = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setCompression($var)
    {
        GPBUtil::checkEnum($var, \Ydb\Table\ColumnFamily\Compression::class);
        $this->compression = $var;

        return $this;
    }

    /**
     * When enabled table data will be kept in memory
     * WARNING: DO NOT USE
     *
     * Generated from protobuf field <code>.Ydb.FeatureFlag.Status keep_in_memory = 4;</code>
     * @return int
     */
    public function getKeepInMemory()
    {
        return $this->keep_in_memory;
    }

    /**
     * When enabled table data will be kept in memory
     * WARNING: DO NOT USE
     *
     * Generated from protobuf field <code>.Ydb.FeatureFlag.Status keep_in_memory = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setKeepInMemory($var)
    {
        GPBUtil::checkEnum($var, \Ydb\FeatureFlag\Status::class);
        $this->keep_in_memory = $var;

        return $this;
    }

}