IndexField.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/firestore/admin/v1/index.proto

namespace Google\Cloud\Firestore\Admin\V1\Index;

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

/**
 * A field in an index.
 * The field_path describes which field is indexed, the value_mode describes
 * how the field value is indexed.
 *
 * Generated from protobuf message <code>google.firestore.admin.v1.Index.IndexField</code>
 */
class IndexField extends \Google\Protobuf\Internal\Message
{
    /**
     * Can be __name__.
     * For single field indexes, this must match the name of the field or may
     * be omitted.
     *
     * Generated from protobuf field <code>string field_path = 1;</code>
     */
    private $field_path = '';
    protected $value_mode;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $field_path
     *           Can be __name__.
     *           For single field indexes, this must match the name of the field or may
     *           be omitted.
     *     @type int $order
     *           Indicates that this field supports ordering by the specified order or
     *           comparing using =, !=, <, <=, >, >=.
     *     @type int $array_config
     *           Indicates that this field supports operations on `array_value`s.
     *     @type \Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig $vector_config
     *           Indicates that this field supports nearest neighbor and distance
     *           operations on vector.
     *     @type \Google\Cloud\Firestore\Admin\V1\Index\IndexField\SearchConfig $search_config
     *           Indicates that this field supports search operations. This field
     *           is only currently supported for indexes with MONGODB_COMPATIBLE_API
     *           ApiScope.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Firestore\Admin\V1\Index::initOnce();
        parent::__construct($data);
    }

    /**
     * Can be __name__.
     * For single field indexes, this must match the name of the field or may
     * be omitted.
     *
     * Generated from protobuf field <code>string field_path = 1;</code>
     * @return string
     */
    public function getFieldPath()
    {
        return $this->field_path;
    }

    /**
     * Can be __name__.
     * For single field indexes, this must match the name of the field or may
     * be omitted.
     *
     * Generated from protobuf field <code>string field_path = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setFieldPath($var)
    {
        GPBUtil::checkString($var, True);
        $this->field_path = $var;

        return $this;
    }

    /**
     * Indicates that this field supports ordering by the specified order or
     * comparing using =, !=, <, <=, >, >=.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.Order order = 2;</code>
     * @return int
     */
    public function getOrder()
    {
        return $this->readOneof(2);
    }

    public function hasOrder()
    {
        return $this->hasOneof(2);
    }

    /**
     * Indicates that this field supports ordering by the specified order or
     * comparing using =, !=, <, <=, >, >=.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.Order order = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setOrder($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\Firestore\Admin\V1\Index\IndexField\Order::class);
        $this->writeOneof(2, $var);

        return $this;
    }

    /**
     * Indicates that this field supports operations on `array_value`s.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;</code>
     * @return int
     */
    public function getArrayConfig()
    {
        return $this->readOneof(3);
    }

    public function hasArrayConfig()
    {
        return $this->hasOneof(3);
    }

    /**
     * Indicates that this field supports operations on `array_value`s.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setArrayConfig($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\Firestore\Admin\V1\Index\IndexField\ArrayConfig::class);
        $this->writeOneof(3, $var);

        return $this;
    }

    /**
     * Indicates that this field supports nearest neighbor and distance
     * operations on vector.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;</code>
     * @return \Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig|null
     */
    public function getVectorConfig()
    {
        return $this->readOneof(4);
    }

    public function hasVectorConfig()
    {
        return $this->hasOneof(4);
    }

    /**
     * Indicates that this field supports nearest neighbor and distance
     * operations on vector.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;</code>
     * @param \Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig $var
     * @return $this
     */
    public function setVectorConfig($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig::class);
        $this->writeOneof(4, $var);

        return $this;
    }

    /**
     * Indicates that this field supports search operations. This field
     * is only currently supported for indexes with MONGODB_COMPATIBLE_API
     * ApiScope.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.SearchConfig search_config = 5;</code>
     * @return \Google\Cloud\Firestore\Admin\V1\Index\IndexField\SearchConfig|null
     */
    public function getSearchConfig()
    {
        return $this->readOneof(5);
    }

    public function hasSearchConfig()
    {
        return $this->hasOneof(5);
    }

    /**
     * Indicates that this field supports search operations. This field
     * is only currently supported for indexes with MONGODB_COMPATIBLE_API
     * ApiScope.
     *
     * Generated from protobuf field <code>.google.firestore.admin.v1.Index.IndexField.SearchConfig search_config = 5;</code>
     * @param \Google\Cloud\Firestore\Admin\V1\Index\IndexField\SearchConfig $var
     * @return $this
     */
    public function setSearchConfig($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Firestore\Admin\V1\Index\IndexField\SearchConfig::class);
        $this->writeOneof(5, $var);

        return $this;
    }

    /**
     * @return string
     */
    public function getValueMode()
    {
        return $this->whichOneof("value_mode");
    }

}