Search Results for

    Show / Hide Table of Contents

    Class ShareSearchAndAggregationBaseRequest

    Request to aggregate shares based on the specified aggregators

    Inheritance
    object
    ShareSearchAndAggregationBaseRequest
    ShareAggregationRequest
    ShareSearchRequest
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public abstract class ShareSearchAndAggregationBaseRequest

    Properties

    AggregationFilters

    Special filters used to filter down independently the aggregations' values and the search results on specific conditions.
    For the search results, the aggregation filters are used to create a Filter that is put in AND with the eventual existing Filter of the search request to nail down the search results. The filters generated
    by the aggregation filters are put in OR each other if they have the same AggregationName, and then such groups are put in AND.
    For the aggregation values, only the original Filter of the search request is used to nail down the data to be considered for the aggregations. Then, on top of that, for each aggregator in the search request, a Filter is created to filter down the
    aggregation results of that aggregation: depending if the AggregationName of the AggregationFilter matches the AggregationName of the Aggregator, the filter is put in OR (if it matches) or in AND (if it does not match it).
    Moreover, an AggregationFilter ensures that the related value is returned in the AggregationResults also if the top aggregation values returned by default do not contain it.

    Declaration
    [JsonProperty("aggregationFilters", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<AggregationFilter> AggregationFilters { get; set; }
    Property Value
    ICollection<AggregationFilter>

    Filter

    An optional search filter. Limits the document result set.

    Declaration
    [JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public FilterBase Filter { get; set; }
    Property Value
    FilterBase

    SearchBehaviors

    An optional list of search behaviors. All the passed behaviors will be applied.

    Declaration
    [JsonProperty("searchBehaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
    public ICollection<SearchBehavior> SearchBehaviors { get; set; }
    Property Value
    ICollection<SearchBehavior>

    SearchString

    Limits the search by using a query string filter. The Lucene query string syntax is supported.

    Declaration
    [JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string SearchString { get; set; }
    Property Value
    string

    Methods

    FromJson(string)

    Declaration
    public static ShareSearchAndAggregationBaseRequest FromJson(string data)
    Parameters
    string data

    Returns
    ShareSearchAndAggregationBaseRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX