Documentation

SearchQueryResponse extends Message
in package

Generated from protobuf message <code>couchbase.search.v1.SearchQueryResponse</code>

Table of Contents

$meta_data  : mixed
Generated from protobuf field <code>optional .couchbase.search.v1.SearchQueryResponse.MetaData meta_data = 3;</code>
$facets  : mixed
Generated from protobuf field <code>map<string, .couchbase.search.v1.SearchQueryResponse.FacetResult> facets = 2;</code>
$hits  : mixed
Generated from protobuf field <code>repeated .couchbase.search.v1.SearchQueryResponse.SearchQueryRow hits = 1;</code>
__construct()  : mixed
Constructor.
clearMetaData()  : mixed
getFacets()  : MapField
Generated from protobuf field <code>map<string, .couchbase.search.v1.SearchQueryResponse.FacetResult> facets = 2;</code>
getHits()  : RepeatedField
Generated from protobuf field <code>repeated .couchbase.search.v1.SearchQueryResponse.SearchQueryRow hits = 1;</code>
getMetaData()  : MetaData|null
Generated from protobuf field <code>optional .couchbase.search.v1.SearchQueryResponse.MetaData meta_data = 3;</code>
hasMetaData()  : mixed
setFacets()  : $this
Generated from protobuf field <code>map<string, .couchbase.search.v1.SearchQueryResponse.FacetResult> facets = 2;</code>
setHits()  : $this
Generated from protobuf field <code>repeated .couchbase.search.v1.SearchQueryResponse.SearchQueryRow hits = 1;</code>
setMetaData()  : $this
Generated from protobuf field <code>optional .couchbase.search.v1.SearchQueryResponse.MetaData meta_data = 3;</code>

Properties

$meta_data

Generated from protobuf field <code>optional .couchbase.search.v1.SearchQueryResponse.MetaData meta_data = 3;</code>

protected mixed $meta_data = null

$facets

Generated from protobuf field <code>map<string, .couchbase.search.v1.SearchQueryResponse.FacetResult> facets = 2;</code>

private mixed $facets

$hits

Generated from protobuf field <code>repeated .couchbase.search.v1.SearchQueryResponse.SearchQueryRow hits = 1;</code>

private mixed $hits

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type array<\Couchbase\Protostellar\Generated\Search\V1\SearchQueryResponse\SearchQueryRow>|\Google\Protobuf\Internal\RepeatedField $hits
@type array|\Google\Protobuf\Internal\MapField $facets
@type \Couchbase\Protostellar\Generated\Search\V1\SearchQueryResponse\MetaData $meta_data

}

Return values
mixed —

getFacets()

Generated from protobuf field <code>map<string, .couchbase.search.v1.SearchQueryResponse.FacetResult> facets = 2;</code>

public getFacets() : MapField
Return values
MapField —

getHits()

Generated from protobuf field <code>repeated .couchbase.search.v1.SearchQueryResponse.SearchQueryRow hits = 1;</code>

public getHits() : RepeatedField
Return values
RepeatedField —

getMetaData()

Generated from protobuf field <code>optional .couchbase.search.v1.SearchQueryResponse.MetaData meta_data = 3;</code>

public getMetaData() : MetaData|null
Return values
MetaData|null —

setFacets()

Generated from protobuf field <code>map<string, .couchbase.search.v1.SearchQueryResponse.FacetResult> facets = 2;</code>

public setFacets(array<string|int, mixed>|MapField $var) : $this
Parameters
$var : array<string|int, mixed>|MapField
Return values
$this —

setHits()

Generated from protobuf field <code>repeated .couchbase.search.v1.SearchQueryResponse.SearchQueryRow hits = 1;</code>

public setHits(array<string|int, SearchQueryRow>|RepeatedField $var) : $this
Parameters
$var : array<string|int, SearchQueryRow>|RepeatedField
Return values
$this —

setMetaData()

Generated from protobuf field <code>optional .couchbase.search.v1.SearchQueryResponse.MetaData meta_data = 3;</code>

public setMetaData(MetaData $var) : $this
Parameters
$var : MetaData
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results