Class GeoPolygonQuery

Performs a random bounding polygon query to select documents within that polygon area.

Inheritance

object

SearchQueryBase

GeoPolygonQuery

Implements

ISearchQuery

Inherited Members

SearchQueryBase.IndexName

SearchQueryBase.Query

SearchQueryBase.Boost(double)

SearchQueryBase.BoostValue

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Search.Queries.Geo

Assembly: Couchbase.NetClient.dll

Syntax

public class GeoPolygonQuery : SearchQueryBase, ISearchQuery

Remarks

This class is Uncommitted and may change in future versions.

Constructors

GeoPolygonQuery(List<Coordinate>)

Creates a GeoPolygonQuery given a list of Coordinate.

Declaration

public GeoPolygonQuery(List<Coordinate> coordinates)

Parameters

Type	Name	Description
List<Coordinate>	coordinates

Methods

AsReadOnly()

Declaration

public GeoPolygonQuery.ReadOnly AsReadOnly()

Returns

Type	Description
GeoPolygonQuery.ReadOnly

Deconstruct(out IReadOnlyList<Coordinate>, out string)

Declaration

public void Deconstruct(out IReadOnlyList<Coordinate> coordinates, out string field)

Parameters

Type	Name	Description
IReadOnlyList<Coordinate>	coordinates
string	field

Export()

Exports the GeoPolygonQuery as a JSON object.

Declaration

[RequiresUnreferencedCode("Couchbase FTS might require types that cannot be statically analyzed. Make sure all required types are preserved.")]
[RequiresDynamicCode("Couchbase FTS might require types that cannot be statically analyzed and might need runtime code generation. Do not use for native AOT applications.")]
public override JObject Export()

Returns

Type	Description
JObject

Overrides

SearchQueryBase.Export()

Field(string)

The optional field to search.

Declaration

public GeoPolygonQuery Field(string field)

Parameters

Type	Name	Description
string	field

Returns

Type	Description
GeoPolygonQuery

Implements

ISearchQuery