google.cloud.retail.v2.SearchResponse.QueryExpansionInfo
*/
class QueryExpansionInfo extends \Google\Protobuf\Internal\Message
{
/**
* Bool describing whether query expansion has occurred.
*
* Generated from protobuf field bool expanded_query = 1;
*/
private $expanded_query = false;
/**
* Number of pinned results. This field will only be set when expansion
* happens and
* [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
* is set to true.
*
* Generated from protobuf field int64 pinned_result_count = 2;
*/
private $pinned_result_count = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type bool $expanded_query
* Bool describing whether query expansion has occurred.
* @type int|string $pinned_result_count
* Number of pinned results. This field will only be set when expansion
* happens and
* [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
* is set to true.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce();
parent::__construct($data);
}
/**
* Bool describing whether query expansion has occurred.
*
* Generated from protobuf field bool expanded_query = 1;
* @return bool
*/
public function getExpandedQuery()
{
return $this->expanded_query;
}
/**
* Bool describing whether query expansion has occurred.
*
* Generated from protobuf field bool expanded_query = 1;
* @param bool $var
* @return $this
*/
public function setExpandedQuery($var)
{
GPBUtil::checkBool($var);
$this->expanded_query = $var;
return $this;
}
/**
* Number of pinned results. This field will only be set when expansion
* happens and
* [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
* is set to true.
*
* Generated from protobuf field int64 pinned_result_count = 2;
* @return int|string
*/
public function getPinnedResultCount()
{
return $this->pinned_result_count;
}
/**
* Number of pinned results. This field will only be set when expansion
* happens and
* [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
* is set to true.
*
* Generated from protobuf field int64 pinned_result_count = 2;
* @param int|string $var
* @return $this
*/
public function setPinnedResultCount($var)
{
GPBUtil::checkInt64($var);
$this->pinned_result_count = $var;
return $this;
}
}