GeoDistanceQuery
extends Message
in package
Generated from protobuf message <code>couchbase.search.v1.GeoDistanceQuery</code>
Table of Contents
- $boost : mixed
- Generated from protobuf field <code>optional float boost = 1;</code>
- $center : mixed
- Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
- $distance : mixed
- Generated from protobuf field <code>string distance = 4;</code>
- $field : mixed
- Generated from protobuf field <code>optional string field = 2;</code>
- __construct() : mixed
- Constructor.
- clearBoost() : mixed
- clearCenter() : mixed
- clearField() : mixed
- getBoost() : float
- Generated from protobuf field <code>optional float boost = 1;</code>
- getCenter() : LatLng|null
- Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
- getDistance() : string
- Generated from protobuf field <code>string distance = 4;</code>
- getField() : string
- Generated from protobuf field <code>optional string field = 2;</code>
- hasBoost() : mixed
- hasCenter() : mixed
- hasField() : mixed
- setBoost() : $this
- Generated from protobuf field <code>optional float boost = 1;</code>
- setCenter() : $this
- Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
- setDistance() : $this
- Generated from protobuf field <code>string distance = 4;</code>
- setField() : $this
- Generated from protobuf field <code>optional string field = 2;</code>
Properties
$boost
Generated from protobuf field <code>optional float boost = 1;</code>
protected
mixed
$boost
= null
$center
Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
protected
mixed
$center
= null
$distance
Generated from protobuf field <code>string distance = 4;</code>
protected
mixed
$distance
= ''
$field
Generated from protobuf field <code>optional string field = 2;</code>
protected
mixed
$field
= 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 $center @type string $distance}
Return values
mixed —clearBoost()
public
clearBoost() : mixed
Return values
mixed —clearCenter()
public
clearCenter() : mixed
Return values
mixed —clearField()
public
clearField() : mixed
Return values
mixed —getBoost()
Generated from protobuf field <code>optional float boost = 1;</code>
public
getBoost() : float
Return values
float —getCenter()
Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
public
getCenter() : LatLng|null
Return values
LatLng|null —getDistance()
Generated from protobuf field <code>string distance = 4;</code>
public
getDistance() : string
Return values
string —getField()
Generated from protobuf field <code>optional string field = 2;</code>
public
getField() : string
Return values
string —hasBoost()
public
hasBoost() : mixed
Return values
mixed —hasCenter()
public
hasCenter() : mixed
Return values
mixed —hasField()
public
hasField() : 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 —setCenter()
Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
public
setCenter(LatLng $var) : $this
Parameters
- $var : LatLng
Return values
$this —setDistance()
Generated from protobuf field <code>string distance = 4;</code>
public
setDistance(string $var) : $this
Parameters
- $var : string
Return values
$this —setField()
Generated from protobuf field <code>optional string field = 2;</code>
public
setField(string $var) : $this
Parameters
- $var : string