google.cloud.retail.v2.SearchRequest.QueryExpansionSpec
*/
class QueryExpansionSpec extends \Google\Protobuf\Internal\Message
{
/**
* The condition under which query expansion should occur. Default to
* [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
*
* Generated from protobuf field .google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;
*/
private $condition = 0;
/**
* Whether to pin unexpanded results. If this field is set to true,
* unexpanded products are always at the top of the search results, followed
* by the expanded results.
*
* Generated from protobuf field bool pin_unexpanded_results = 2;
*/
private $pin_unexpanded_results = false;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type int $condition
* The condition under which query expansion should occur. Default to
* [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
* @type bool $pin_unexpanded_results
* Whether to pin unexpanded results. If this field is set to true,
* unexpanded products are always at the top of the search results, followed
* by the expanded results.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce();
parent::__construct($data);
}
/**
* The condition under which query expansion should occur. Default to
* [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
*
* Generated from protobuf field .google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;
* @return int
*/
public function getCondition()
{
return $this->condition;
}
/**
* The condition under which query expansion should occur. Default to
* [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
*
* Generated from protobuf field .google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;
* @param int $var
* @return $this
*/
public function setCondition($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Retail\V2\SearchRequest\QueryExpansionSpec\Condition::class);
$this->condition = $var;
return $this;
}
/**
* Whether to pin unexpanded results. If this field is set to true,
* unexpanded products are always at the top of the search results, followed
* by the expanded results.
*
* Generated from protobuf field bool pin_unexpanded_results = 2;
* @return bool
*/
public function getPinUnexpandedResults()
{
return $this->pin_unexpanded_results;
}
/**
* Whether to pin unexpanded results. If this field is set to true,
* unexpanded products are always at the top of the search results, followed
* by the expanded results.
*
* Generated from protobuf field bool pin_unexpanded_results = 2;
* @param bool $var
* @return $this
*/
public function setPinUnexpandedResults($var)
{
GPBUtil::checkBool($var);
$this->pin_unexpanded_results = $var;
return $this;
}
}