google.firestore.admin.v1.Index.IndexField
*/
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 string field_path = 1;
*/
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.
* }
*/
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 string field_path = 1;
* @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 string field_path = 1;
* @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 .google.firestore.admin.v1.Index.IndexField.Order order = 2;
* @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 .google.firestore.admin.v1.Index.IndexField.Order order = 2;
* @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 .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
* @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 .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
* @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;
}
/**
* @return string
*/
public function getValueMode()
{
return $this->whichOneof("value_mode");
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(IndexField::class, \Google\Cloud\Firestore\Admin\V1\Index_IndexField::class);