[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class UserSearchRequest : UserSearchAndAggregationBaseRequest

Properties

Aggregators

List of aggregators that defines how the items should be aggregated.

Declaration

[JsonProperty("aggregators", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregatorBase> Aggregators { get; set; }

Property Value

ICollection<AggregatorBase>

DebugMode

Enable debug mode to get as result of the Searched additional debug information. Warning! Severely affects performance.

Declaration

[JsonProperty("debugMode", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool DebugMode { get; set; }

Property Value

bool

Limit

Limits the document count of the result set.

Declaration

[JsonProperty("limit", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public int Limit { get; set; }

Property Value

int

PageToken

The token used to retrieve the next page of results. It must be null on first request and only filled with the returned pageToken to request next page of results.

Declaration

[JsonProperty("pageToken", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string PageToken { get; set; }

Property Value

string

Sort

Fields and respective directions requested to sort the search results. Sorting on a not indexed field will throw an exception.

Declaration

[JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<SortInfo> Sort { get; set; }

Property Value

ICollection<SortInfo>

Methods

FromJson(string)

Declaration

public static UserSearchRequest FromJson(string data)

Parameters

string data

Returns

UserSearchRequest

ToJson()

Declaration

public string ToJson()

Returns

string