GroupByScientificNameQuerySpec: GroupByScientificNameQuerySpec Class
In naturalis/nbaR: R Package Client for the Netherlands Biodiversity API

GroupByScientificNameQuerySpec

R Documentation

GroupByScientificNameQuerySpec Class

For more information on the NBA object model, please refer to the official NBA documentation at https://docs.biodiversitydata.nl and the NBA model and endpoints reference at https://docs.biodiversitydata.nl/endpoints-reference.

# GroupByScientificNameQuerySpec$new()

R6 class

Model class for GroupByScientificNameQuerySpec objects.

constantScore: logical If true, no relevance scores will be calculated for the returned documents. By default Elasticsearch not only determines whether a document matches your search criteria, but also how well it matches them, expressed as a so-called relevance score. If you are not interested in relevance scores, set constantScore to true, as there is some performance overhead associated with calculating relevance scores.
fields: list(character) The fields to be returned. Specimen, Taxon and MultiMediaObject documents are large documents containing lots of fields. If you are only interested in a few fields, use the fields property to specify them.
conditions: list(QueryCondition) List of QueryCondition objetcs
logicalOperator: character (AND/OR) Specifies whether a document must satisfy all search criteria or just one in order to be returned.
sortFields: list(SortField) Specifies the field(s) on which to sort the documents.
from: integer The offset in the result set from which to return the documents.
size: integer The number of documents to return.
groupSort: character
groupFilter: Filter
specimensFrom: integer
specimensSize: integer
specimensSortFields: list(SortField)
noTaxa: logical

$new(): Constructor GroupByScientificNameQuerySpec object.
$fromList(GroupByScientificNameQuerySpecList): Create GroupByScientificNameQuerySpec object from list.
$toList(): Get list representation of GroupByScientificNameQuerySpec.
fromJSONString(GroupByScientificNameQuerySpecJson): Create GroupByScientificNameQuerySpec object from JSON.
toJSONString(pretty=TRUE): Get JSON representation of GroupByScientificNameQuerySpec.