Documentation

TermQuery extends Message
in package

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

Table of Contents

$boost  : mixed
Generated from protobuf field <code>optional float boost = 1;</code>
$field  : mixed
Generated from protobuf field <code>optional string field = 2;</code>
$fuzziness  : mixed
Generated from protobuf field <code>optional uint64 fuzziness = 4;</code>
$prefix_length  : mixed
Generated from protobuf field <code>optional uint64 prefix_length = 5;</code>
$term  : mixed
Generated from protobuf field <code>string term = 3;</code>
__construct()  : mixed
Constructor.
clearBoost()  : mixed
clearField()  : mixed
clearFuzziness()  : mixed
clearPrefixLength()  : mixed
getBoost()  : float
Generated from protobuf field <code>optional float boost = 1;</code>
getField()  : string
Generated from protobuf field <code>optional string field = 2;</code>
getFuzziness()  : int|string
Generated from protobuf field <code>optional uint64 fuzziness = 4;</code>
getPrefixLength()  : int|string
Generated from protobuf field <code>optional uint64 prefix_length = 5;</code>
getTerm()  : string
Generated from protobuf field <code>string term = 3;</code>
hasBoost()  : mixed
hasField()  : mixed
hasFuzziness()  : mixed
hasPrefixLength()  : mixed
setBoost()  : $this
Generated from protobuf field <code>optional float boost = 1;</code>
setField()  : $this
Generated from protobuf field <code>optional string field = 2;</code>
setFuzziness()  : $this
Generated from protobuf field <code>optional uint64 fuzziness = 4;</code>
setPrefixLength()  : $this
Generated from protobuf field <code>optional uint64 prefix_length = 5;</code>
setTerm()  : $this
Generated from protobuf field <code>string term = 3;</code>

Properties

$boost

Generated from protobuf field <code>optional float boost = 1;</code>

protected mixed $boost = null

$field

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

protected mixed $field = null

$fuzziness

Generated from protobuf field <code>optional uint64 fuzziness = 4;</code>

protected mixed $fuzziness = null

$prefix_length

Generated from protobuf field <code>optional uint64 prefix_length = 5;</code>

protected mixed $prefix_length = null

$term

Generated from protobuf field <code>string term = 3;</code>

protected mixed $term = ''

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 float $boost
@type string $field
@type string $term
@type int|string $fuzziness
@type int|string $prefix_length

}

Return values
mixed

clearBoost()

public clearBoost() : mixed
Return values
mixed

clearField()

public clearField() : mixed
Return values
mixed

clearFuzziness()

public clearFuzziness() : mixed
Return values
mixed

clearPrefixLength()

public clearPrefixLength() : mixed
Return values
mixed

getBoost()

Generated from protobuf field <code>optional float boost = 1;</code>

public getBoost() : float
Return values
float

getField()

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

public getField() : string
Return values
string

getFuzziness()

Generated from protobuf field <code>optional uint64 fuzziness = 4;</code>

public getFuzziness() : int|string
Return values
int|string

getPrefixLength()

Generated from protobuf field <code>optional uint64 prefix_length = 5;</code>

public getPrefixLength() : int|string
Return values
int|string

getTerm()

Generated from protobuf field <code>string term = 3;</code>

public getTerm() : string
Return values
string

hasBoost()

public hasBoost() : mixed
Return values
mixed

hasField()

public hasField() : mixed
Return values
mixed

hasFuzziness()

public hasFuzziness() : mixed
Return values
mixed

hasPrefixLength()

public hasPrefixLength() : mixed
Return values
mixed

setBoost()

Generated from protobuf field <code>optional float boost = 1;</code>

public setBoost(float $var) : $this
Parameters
$var : float
Return values
$this

setField()

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

public setField(string $var) : $this
Parameters
$var : string
Return values
$this

setFuzziness()

Generated from protobuf field <code>optional uint64 fuzziness = 4;</code>

public setFuzziness(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setPrefixLength()

Generated from protobuf field <code>optional uint64 prefix_length = 5;</code>

public setPrefixLength(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setTerm()

Generated from protobuf field <code>string term = 3;</code>

public setTerm(string $var) : $this
Parameters
$var : string
Return values
$this

        

Search results