Documentation

GeoPolygonQuery extends Message
in package

Generated from protobuf message <code>couchbase.search.v1.GeoPolygonQuery</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>
$vertices  : mixed
Generated from protobuf field <code>repeated .couchbase.search.v1.LatLng vertices = 3;</code>
__construct()  : mixed
Constructor.
clearBoost()  : mixed
clearField()  : 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>
getVertices()  : RepeatedField
Generated from protobuf field <code>repeated .couchbase.search.v1.LatLng vertices = 3;</code>
hasBoost()  : mixed
hasField()  : 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>
setVertices()  : $this
Generated from protobuf field <code>repeated .couchbase.search.v1.LatLng vertices = 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

$vertices

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

private mixed $vertices

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 array<\Couchbase\Protostellar\Generated\Search\V1\LatLng>|\Google\Protobuf\Internal\RepeatedField $vertices

}

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

getVertices()

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

public getVertices() : RepeatedField
Return values
RepeatedField

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

setVertices()

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

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

        

Search results