FacetOptions class

Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.

Constructors

FacetOptions({Input<IntegerFacetingOptions>? integerFacetingOptions, Input<int>? numFacetBuckets, Input<String>? objectType, Input<String>? operatorName, Input<String>? sourceName})

Creates a new FacetOptions. integerFacetingOptions If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets. numFacetBuckets Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100. objectType If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets. operatorName The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions sourceName Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.

const

FacetOptions.fromMap(Map<String, dynamic> map)

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

integerFacetingOptions → Input<IntegerFacetingOptions>?

If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.

final

numFacetBuckets → Input<int>?

Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.

final

objectType → Input<String>?

If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.

final

operatorName → Input<String>?

The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceName → Input<String>?

Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited