Documentation

GeoBoundingBoxQuery extends Message
in package

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

Table of Contents

$boost  : mixed
Generated from protobuf field <code>optional float boost = 1;</code>
$bottom_right  : mixed
Generated from protobuf field <code>.couchbase.search.v1.LatLng bottom_right = 4;</code>
$field  : mixed
Generated from protobuf field <code>optional string field = 2;</code>
$top_left  : mixed
Generated from protobuf field <code>.couchbase.search.v1.LatLng top_left = 3;</code>
__construct()  : mixed
Constructor.
clearBoost()  : mixed
clearBottomRight()  : mixed
clearField()  : mixed
clearTopLeft()  : mixed
getBoost()  : float
Generated from protobuf field <code>optional float boost = 1;</code>
getBottomRight()  : LatLng|null
Generated from protobuf field <code>.couchbase.search.v1.LatLng bottom_right = 4;</code>
getField()  : string
Generated from protobuf field <code>optional string field = 2;</code>
getTopLeft()  : LatLng|null
Generated from protobuf field <code>.couchbase.search.v1.LatLng top_left = 3;</code>
hasBoost()  : mixed
hasBottomRight()  : mixed
hasField()  : mixed
hasTopLeft()  : mixed
setBoost()  : $this
Generated from protobuf field <code>optional float boost = 1;</code>
setBottomRight()  : $this
Generated from protobuf field <code>.couchbase.search.v1.LatLng bottom_right = 4;</code>
setField()  : $this
Generated from protobuf field <code>optional string field = 2;</code>
setTopLeft()  : $this
Generated from protobuf field <code>.couchbase.search.v1.LatLng top_left = 3;</code>

Properties

$boost

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

protected mixed $boost = null

$bottom_right

Generated from protobuf field <code>.couchbase.search.v1.LatLng bottom_right = 4;</code>

protected mixed $bottom_right = null

$field

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

protected mixed $field = null

$top_left

Generated from protobuf field <code>.couchbase.search.v1.LatLng top_left = 3;</code>

protected mixed $top_left = null

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 \Couchbase\Protostellar\Generated\Search\V1\LatLng $top_left
@type \Couchbase\Protostellar\Generated\Search\V1\LatLng $bottom_right

}

Return values
mixed

getBoost()

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

public getBoost() : float
Return values
float

getBottomRight()

Generated from protobuf field <code>.couchbase.search.v1.LatLng bottom_right = 4;</code>

public getBottomRight() : LatLng|null
Return values
LatLng|null

getField()

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

public getField() : string
Return values
string

getTopLeft()

Generated from protobuf field <code>.couchbase.search.v1.LatLng top_left = 3;</code>

public getTopLeft() : LatLng|null
Return values
LatLng|null

setBoost()

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

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

setBottomRight()

Generated from protobuf field <code>.couchbase.search.v1.LatLng bottom_right = 4;</code>

public setBottomRight(LatLng $var) : $this
Parameters
$var : LatLng
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

setTopLeft()

Generated from protobuf field <code>.couchbase.search.v1.LatLng top_left = 3;</code>

public setTopLeft(LatLng $var) : $this
Parameters
$var : LatLng
Return values
$this

        

Search results