Documentation

SearchQueryRequest extends Message
in package

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

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>optional string bucket_name = 15;</code>
$disable_scoring  : mixed
Generated from protobuf field <code>bool disable_scoring = 11;</code>
$highlight_style  : mixed
Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.HighlightStyle highlight_style = 7;</code>
$include_explanation  : mixed
Generated from protobuf field <code>bool include_explanation = 6;</code>
$include_locations  : mixed
Generated from protobuf field <code>bool include_locations = 13;</code>
$index_name  : mixed
Generated from protobuf field <code>string index_name = 1;</code>
$limit  : mixed
Generated from protobuf field <code>uint32 limit = 4;</code>
$query  : mixed
Generated from protobuf field <code>.couchbase.search.v1.Query query = 2;</code>
$scan_consistency  : mixed
Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.ScanConsistency scan_consistency = 3;</code>
$scope_name  : mixed
Generated from protobuf field <code>optional string scope_name = 16;</code>
$skip  : mixed
Generated from protobuf field <code>uint32 skip = 5;</code>
$collections  : mixed
Generated from protobuf field <code>repeated string collections = 12;</code>
$facets  : mixed
Generated from protobuf field <code>map<string, .couchbase.search.v1.Facet> facets = 14;</code>
$fields  : mixed
Generated from protobuf field <code>repeated string fields = 9;</code>
$highlight_fields  : mixed
Generated from protobuf field <code>repeated string highlight_fields = 8;</code>
$sort  : mixed
Generated from protobuf field <code>repeated .couchbase.search.v1.Sorting sort = 10;</code>
__construct()  : mixed
Constructor.
clearBucketName()  : mixed
clearQuery()  : mixed
clearScopeName()  : mixed
getBucketName()  : string
Generated from protobuf field <code>optional string bucket_name = 15;</code>
getCollections()  : RepeatedField
Generated from protobuf field <code>repeated string collections = 12;</code>
getDisableScoring()  : bool
Generated from protobuf field <code>bool disable_scoring = 11;</code>
getFacets()  : MapField
Generated from protobuf field <code>map<string, .couchbase.search.v1.Facet> facets = 14;</code>
getFields()  : RepeatedField
Generated from protobuf field <code>repeated string fields = 9;</code>
getHighlightFields()  : RepeatedField
Generated from protobuf field <code>repeated string highlight_fields = 8;</code>
getHighlightStyle()  : int
Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.HighlightStyle highlight_style = 7;</code>
getIncludeExplanation()  : bool
Generated from protobuf field <code>bool include_explanation = 6;</code>
getIncludeLocations()  : bool
Generated from protobuf field <code>bool include_locations = 13;</code>
getIndexName()  : string
Generated from protobuf field <code>string index_name = 1;</code>
getLimit()  : int
Generated from protobuf field <code>uint32 limit = 4;</code>
getQuery()  : Query|null
Generated from protobuf field <code>.couchbase.search.v1.Query query = 2;</code>
getScanConsistency()  : int
Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.ScanConsistency scan_consistency = 3;</code>
getScopeName()  : string
Generated from protobuf field <code>optional string scope_name = 16;</code>
getSkip()  : int
Generated from protobuf field <code>uint32 skip = 5;</code>
getSort()  : RepeatedField
Generated from protobuf field <code>repeated .couchbase.search.v1.Sorting sort = 10;</code>
hasBucketName()  : mixed
hasQuery()  : mixed
hasScopeName()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>optional string bucket_name = 15;</code>
setCollections()  : $this
Generated from protobuf field <code>repeated string collections = 12;</code>
setDisableScoring()  : $this
Generated from protobuf field <code>bool disable_scoring = 11;</code>
setFacets()  : $this
Generated from protobuf field <code>map<string, .couchbase.search.v1.Facet> facets = 14;</code>
setFields()  : $this
Generated from protobuf field <code>repeated string fields = 9;</code>
setHighlightFields()  : $this
Generated from protobuf field <code>repeated string highlight_fields = 8;</code>
setHighlightStyle()  : $this
Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.HighlightStyle highlight_style = 7;</code>
setIncludeExplanation()  : $this
Generated from protobuf field <code>bool include_explanation = 6;</code>
setIncludeLocations()  : $this
Generated from protobuf field <code>bool include_locations = 13;</code>
setIndexName()  : $this
Generated from protobuf field <code>string index_name = 1;</code>
setLimit()  : $this
Generated from protobuf field <code>uint32 limit = 4;</code>
setQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.Query query = 2;</code>
setScanConsistency()  : $this
Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.ScanConsistency scan_consistency = 3;</code>
setScopeName()  : $this
Generated from protobuf field <code>optional string scope_name = 16;</code>
setSkip()  : $this
Generated from protobuf field <code>uint32 skip = 5;</code>
setSort()  : $this
Generated from protobuf field <code>repeated .couchbase.search.v1.Sorting sort = 10;</code>

Properties

$bucket_name

Generated from protobuf field <code>optional string bucket_name = 15;</code>

protected mixed $bucket_name = null

$disable_scoring

Generated from protobuf field <code>bool disable_scoring = 11;</code>

protected mixed $disable_scoring = false

$highlight_style

Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.HighlightStyle highlight_style = 7;</code>

protected mixed $highlight_style = 0

$include_explanation

Generated from protobuf field <code>bool include_explanation = 6;</code>

protected mixed $include_explanation = false

$include_locations

Generated from protobuf field <code>bool include_locations = 13;</code>

protected mixed $include_locations = false

$index_name

Generated from protobuf field <code>string index_name = 1;</code>

protected mixed $index_name = ''

$limit

Generated from protobuf field <code>uint32 limit = 4;</code>

protected mixed $limit = 0

$query

Generated from protobuf field <code>.couchbase.search.v1.Query query = 2;</code>

protected mixed $query = null

$scan_consistency

Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.ScanConsistency scan_consistency = 3;</code>

protected mixed $scan_consistency = 0

$scope_name

Generated from protobuf field <code>optional string scope_name = 16;</code>

protected mixed $scope_name = null

$skip

Generated from protobuf field <code>uint32 skip = 5;</code>

protected mixed $skip = 0

$collections

Generated from protobuf field <code>repeated string collections = 12;</code>

private mixed $collections

$facets

Generated from protobuf field <code>map<string, .couchbase.search.v1.Facet> facets = 14;</code>

private mixed $facets

$fields

Generated from protobuf field <code>repeated string fields = 9;</code>

private mixed $fields

$highlight_fields

Generated from protobuf field <code>repeated string highlight_fields = 8;</code>

private mixed $highlight_fields

$sort

Generated from protobuf field <code>repeated .couchbase.search.v1.Sorting sort = 10;</code>

private mixed $sort

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 string $index_name
@type \Couchbase\Protostellar\Generated\Search\V1\Query $query
@type int $scan_consistency
@type int $limit
@type int $skip
@type bool $include_explanation
@type int $highlight_style
@type array<string>|\Google\Protobuf\Internal\RepeatedField $highlight_fields
@type array<string>|\Google\Protobuf\Internal\RepeatedField $fields
@type array<\Couchbase\Protostellar\Generated\Search\V1\Sorting>|\Google\Protobuf\Internal\RepeatedField $sort
@type bool $disable_scoring
@type array<string>|\Google\Protobuf\Internal\RepeatedField $collections
@type bool $include_locations
@type array|\Google\Protobuf\Internal\MapField $facets
@type string $bucket_name
@type string $scope_name

}

Return values
mixed —

getBucketName()

Generated from protobuf field <code>optional string bucket_name = 15;</code>

public getBucketName() : string
Return values
string —

getCollections()

Generated from protobuf field <code>repeated string collections = 12;</code>

public getCollections() : RepeatedField
Return values
RepeatedField —

getDisableScoring()

Generated from protobuf field <code>bool disable_scoring = 11;</code>

public getDisableScoring() : bool
Return values
bool —

getFacets()

Generated from protobuf field <code>map<string, .couchbase.search.v1.Facet> facets = 14;</code>

public getFacets() : MapField
Return values
MapField —

getFields()

Generated from protobuf field <code>repeated string fields = 9;</code>

public getFields() : RepeatedField
Return values
RepeatedField —

getHighlightFields()

Generated from protobuf field <code>repeated string highlight_fields = 8;</code>

public getHighlightFields() : RepeatedField
Return values
RepeatedField —

getHighlightStyle()

Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.HighlightStyle highlight_style = 7;</code>

public getHighlightStyle() : int
Return values
int —

getIncludeExplanation()

Generated from protobuf field <code>bool include_explanation = 6;</code>

public getIncludeExplanation() : bool
Return values
bool —

getIncludeLocations()

Generated from protobuf field <code>bool include_locations = 13;</code>

public getIncludeLocations() : bool
Return values
bool —

getIndexName()

Generated from protobuf field <code>string index_name = 1;</code>

public getIndexName() : string
Return values
string —

getLimit()

Generated from protobuf field <code>uint32 limit = 4;</code>

public getLimit() : int
Return values
int —

getQuery()

Generated from protobuf field <code>.couchbase.search.v1.Query query = 2;</code>

public getQuery() : Query|null
Return values
Query|null —

getScanConsistency()

Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.ScanConsistency scan_consistency = 3;</code>

public getScanConsistency() : int
Return values
int —

getScopeName()

Generated from protobuf field <code>optional string scope_name = 16;</code>

public getScopeName() : string
Return values
string —

getSkip()

Generated from protobuf field <code>uint32 skip = 5;</code>

public getSkip() : int
Return values
int —

getSort()

Generated from protobuf field <code>repeated .couchbase.search.v1.Sorting sort = 10;</code>

public getSort() : RepeatedField
Return values
RepeatedField —

setBucketName()

Generated from protobuf field <code>optional string bucket_name = 15;</code>

public setBucketName(string $var) : $this
Parameters
$var : string
Return values
$this —

setCollections()

Generated from protobuf field <code>repeated string collections = 12;</code>

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

setDisableScoring()

Generated from protobuf field <code>bool disable_scoring = 11;</code>

public setDisableScoring(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setFacets()

Generated from protobuf field <code>map<string, .couchbase.search.v1.Facet> facets = 14;</code>

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

setFields()

Generated from protobuf field <code>repeated string fields = 9;</code>

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

setHighlightFields()

Generated from protobuf field <code>repeated string highlight_fields = 8;</code>

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

setHighlightStyle()

Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.HighlightStyle highlight_style = 7;</code>

public setHighlightStyle(int $var) : $this
Parameters
$var : int
Return values
$this —

setIncludeExplanation()

Generated from protobuf field <code>bool include_explanation = 6;</code>

public setIncludeExplanation(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setIncludeLocations()

Generated from protobuf field <code>bool include_locations = 13;</code>

public setIncludeLocations(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setIndexName()

Generated from protobuf field <code>string index_name = 1;</code>

public setIndexName(string $var) : $this
Parameters
$var : string
Return values
$this —

setLimit()

Generated from protobuf field <code>uint32 limit = 4;</code>

public setLimit(int $var) : $this
Parameters
$var : int
Return values
$this —

setQuery()

Generated from protobuf field <code>.couchbase.search.v1.Query query = 2;</code>

public setQuery(Query $var) : $this
Parameters
$var : Query
Return values
$this —

setScanConsistency()

Generated from protobuf field <code>.couchbase.search.v1.SearchQueryRequest.ScanConsistency scan_consistency = 3;</code>

public setScanConsistency(int $var) : $this
Parameters
$var : int
Return values
$this —

setScopeName()

Generated from protobuf field <code>optional string scope_name = 16;</code>

public setScopeName(string $var) : $this
Parameters
$var : string
Return values
$this —

setSkip()

Generated from protobuf field <code>uint32 skip = 5;</code>

public setSkip(int $var) : $this
Parameters
$var : int
Return values
$this —

setSort()

Generated from protobuf field <code>repeated .couchbase.search.v1.Sorting sort = 10;</code>

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

        

        
    




    

    

                

    

        

            
Search results