search

type AnalyzerParam struct {
	AnalyzerValue string `json:"analyzer,omitempty" bson:"analyzer,omitempty"`
}

type AutoGenerateSynonymsPhraseQueryParam struct {
	AutoGenerateSynonymsPhraseQueryValue *bool `bson:"auto_generate_synonyms_phrase_query,omitempty" json:"auto_generate_synonyms_phrase_query,omitempty"`
}

type BoostParam struct {
	BoostValue *float32 `bson:"boost,omitempty" json:"boost,omitempty"`
}

type Builder struct {
	Defaults *Search
}

type CaseInsensitiveParam struct {
	CaseInsensitiveValue *bool `json:"case_insensitive,omitempty" bson:"case_insensitive,omitempty"`
}

type DocValueFields Fields

type Exists struct {
	Field string `json:"field" bson:"field"`
}

type Field struct {
	// (Required, string) Wildcard pattern. The request returns doc values for
	// field names matching this pattern.
	Field string `bson:"field" json:"field"`

	// (Optional, string) Format in which the doc values are returned.
	//
	// For date fields, you can specify a date date format. For numeric fields
	// fields, you can specify a DecimalFormat pattern.
	//
	// For other field data types, this parameter is not supported.
	Format string `bson:"format,omitempty" json:"format,omitempty"`
}

type Fields []Field

type FuzzinessParam struct {
	FuzzinessValue    string  `json:"fuzziness,omitempty" bson:"fuzziness,omitempty"`
	FuzzyRewriteValue Rewrite `json:"fuzzy_rewrite,omitempty" bson:"fuzzy_rewrite,omitempty"`
}

type Fuzzy struct {
	Value               string `json:"value" bson:"value"`
	FuzzinessParam      `json:",inline" bson:",inline"`
	MaxExpansionsParam  `json:",inline" bson:",inline"`
	PrefixLengthParam   `json:",inline" bson:",inline"`
	TranspositionsParam `json:",inline" bson:",inline"`
	RewriteParam        `json:",inline" bson:",inline"`
}

type FuzzyQuery struct {
	Fuzzy map[string]Fuzzy `json:"fuzzy,omitempty" bson:"fuzzy,omitempty"`
}

type FuzzyTranspositionsParam struct {
	FuzzyTranspositionsValue *bool `json:"fuzzy_transpositions,omitempty" bson:"fuzzy_transpositions,omitempty"`
}

type IDsQuery struct {
	IDs []string `json:"values" bson:"values"`
}

type IndicesBoost map[string]float32

type LenientParam struct {
	LenientValue *bool `json:"lenient,omitempty" bson:"lenient,omitempty"`
}

type Match struct {
	Query                             interface{}
	Analyzer                          string
	NoAutoGenerateSynonymsPhraseQuery bool
	NoFuzzyTranspositions             bool
	Fuzziness                         string
	FuzzyRewrite                      Rewrite
	Lenient                           bool
	Operator                          Operator
	MaxExpansions                     int
	PrefixLength                      int
	MinimumShouldMatchParam           string
	ZeroTermsQuery                    ZeroTermsQuery
}

type MatchBooleanPrefix struct {
	Query                    string `json:"query" bson:"query"`
	MinimumShouldMatchParam  `json:",inline" bson:",inline"`
	OperatorParam            `json:",inline" bson:",inline"`
	AnalyzerParam            `json:",inline" bson:",inline"`
	FuzzinessParam           `json:",inline" bson:",inline"`
	PrefixLengthParam        `json:",inline" bson:",inline"`
	FuzzyTranspositionsParam `json:",inline" bson:",inline"`
}

type MatchBooleanPrefixQuery struct {
	MatchBooleanPrefix map[string]MatchBooleanPrefix `json:"match_boolean_prefix,omitempty" bson:"match_boolean_prefix,omitempty"`
}

type MatchPhrase struct {
	Query               string `json:"query" bson:"query"`
	AnalyzerParam       `json:",inline" bson:",inline"`
	ZeroTermsQueryParam `json:",inline" bson:",inline"`
}

type MatchPhrasePrefix struct {
	Query              string `json:"query" bson:"query"`
	AnalyzerParam      `json:",inline" bson:",inline"`
	MaxExpansionsParam `json:",inline" bson:",inline"`
	SlopParam          `json:",inline" bson:",inline"`
	ZeroTermsQuery     `json:",inline" bson:",inline"`
}

type MatchPhrasePrefixQuery struct {
	MatchPhrasePrefix map[string]MatchBooleanPrefix `json:"match_phrase_prefix,omitempty" bson:"match_phrase_prefix,omitempty"`
}

type MatchPhraseQuery struct {
	MatchPhrase map[string]MatchPhrase `json:"match_phrase,omitempty" bson:"match_phrase,omitempty"`
}

type MatchQuery struct {
	MatchQueryValue map[string]MatchQueryValue `json:"match,omitempty" bson:"match,omitempty"`
}

type MatchQueryValue struct {
	// (Required) Text, number, boolean value or date you wish to find in the
	// provided <field>.
	//
	// The match query analyzes any provided text before performing a search.
	// This means the match query can search text fields for analyzed tokens
	// rather than an exact term.
	Query dynamic.StringNumberBoolOrTime `json:"query" bson:"query"`

	// Analyzer used to convert the text in the query value into tokens.
	// Defaults to the index-time analyzer mapped for the <field>. If no
	// analyzer is mapped, the index’s default analyzer is used.
	AnalyzerParam `json:",inline" bson:",inline"`

	// If true, match phrase queries are automatically created for multi-term
	// synonyms. Defaults to true.
	AutoGenerateSynonymsPhraseQueryParam `json:",inline" bson:",inline"`

	// Maximum edit distance allowed for matching.
	FuzzinessParam `json:",inline" bson:",inline"`

	// Maximum number of terms to which the query will expand. Defaults to 50.
	MaxExpansionsParam `json:",inline" bson:",inline"`

	// Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.
	PrefixLengthParam `json:",inline" bson:",inline"`

	// If true, edits for fuzzy matching include transpositions of two adjacent
	// characters (ab → ba). Defaults to true.
	FuzzyTranspositionsParam `json:",inline" bson:",inline"`

	//  If true, format-based errors, such as providing a text query value for a
	//  numeric field, are ignored. Defaults to false.
	LenientParam `json:",inline" bson:",inline"`

	// Boolean logic used to interpret text in the query value.
	OperatorParam `json:",inline" bson:",inline"`

	// Minimum number of clauses that must match for a document to be returned
	//
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html
	MinimumShouldMatchParam `json:",inline" bson:",inline"`
	// Indicates whether no documents are returned if the analyzer removes all
	// tokens, such as when using a stop filter.
	ZeroTermsQueryParam `json:",inline" bson:",inline"`
}

type MaxExpansionsParam struct {
	MaxExpansionsValue *int `json:"max_expansions,omitempty" bson:"max_expansions,omitempty"`
}

type MinimumShouldMatchParam struct {
	MimimumShouldMatchValue *string `json:"minimum_should_match,omitempty" bson:"minimum_should_match,omitempty"`
}

type Operator string

type OperatorParam struct {
	OperatorValue *Operator `json:"operator,omitempty" bson:"operator,omitempty"`
}

type PointInTime struct {
	ID        string     `bson:"id" json:"id"`
	KeepAlive *time.Time `bson:"keep_alive,omitempty" json:"keep_alive,omitempty"`
}

type Prefix struct {
	Value             string
	Rewrite           Rewrite
	IsCaseInsensitive bool
}

type PrefixLengthParam struct {
	PrefixLengthValue *int `json:"prefix_length,omitempty" bson:"prefix_length,omitempty"`
}

type PrefixQuery struct {
	PrefixQueryValue `json:"prefix,omitempty" bson:"prefix,omitempty"`
}

type PrefixQueryValue struct {
	Value                string `json:"value" bson:"value"`
	RewriteParam         `json:",inline" bson:",inline"`
	CaseInsensitiveParam `json:",inline" bson:",inline"`
}

type Query struct {
	MatchQuery `json:",inline" bson:",inline"`
}

type QueryError struct {
	Field     string
	Err       error
	QueryType QueryType
}

type QueryType string

type QueryWithCaseInsensitive interface {
	CaseInsensitive() bool
	SetCaseInsensitive(v bool)
}

type Rewrite string

type RewriteParam struct {
	RewriteValue *Rewrite `json:"rewrite,omitempty" bson:"rewrite,omitempty"`
}

type RuntimeMappingField struct {
	Type   RuntimeMappingType `bson:"type" json:"type"`
	Script string             `bson:"script,omitempty" json:"script,omitempty"`
}

type RuntimeMappingType string

type RuntimeMappings map[string]RuntimeMappingField

type Search struct {
	// Array of wildcard (*) patterns. The request returns doc values for field
	// names matching these patterns in the hits.fields property of the response
	// (Optional) .
	//
	// You can specify items in the array as a string or object.
	DocValueFieldsValue DocValueFields `bson:"docvalue_fields,omitempty" json:"docvalue_fields,omitempty"`

	// Array of wildcard (*) patterns. The request returns values for field
	// names matching these patterns in the hits.fields property of the response
	// (Optional).
	//
	// You can specify items in the array as a string or object.
	FieldsValue Fields `bson:"fields,omitempty" json:"fields,omitempty"`

	// (Optional, Boolean) If true, returns detailed information about score
	// computation as part of a hit. Defaults to false.
	ExplainValue *bool `bson:"epxlain,omitempty" json:"explain,omitempty"`

	// Starting document offset. Defaults to 0.
	//
	// By default, you cannot page through more than 10,000 hits using the from
	// and size parameters. To page through more hits, use the search_after
	// parameter.
	FromValue *int `bson:"from,omitempty" json:"from,omitempty"`

	// Boosts the _score of documents from specified indices (Optional).
	IndicesBoostValue IndicesBoost `bson:"indices_boost,omitempty"`

	// Minimum _score for matching documents. Documents with a lower _score are
	// not included in the search results (Optional, float).
	MinScoreValue *float32 `bson:"min_score,omitempty" json:"min_score,omitempty"`

	// Limits the search to a point in time (PIT). If you provide a pit, you
	// cannot specify a <target> in the request path. (Optional)
	PointInTimeValue *PointInTime `bson:"pit,omitempty" json:"pit,omitempty"`

	// Defines the search definition using the Query DSL. (Optional)
	QueryValue *Query `bson:"query,omitempty" json:"query,omitempty"`

	//  Defines a runtime field in the search request that exist only as part of
	//  the query. Fields defined in the search request take precedence over
	//  fields defined with the same name in the index mappings. (Optional)
	RuntimeMappingsValue RuntimeMappings `bson:"runtime_mappings,omitempty" json:"runtime_mappings,omitempty"`

	// If true, returns sequence number and primary term of the last
	// modification of each hit. See Optimistic concurrency control. (Optional)
	SeqNoPrimaryTermValue *bool `bson:"seq_no_primary_term,omitempty" json:"seq_no_primary_term,omitempty"`
	// The number of hits to return. Defaults to 10. (Optional)
	//
	// By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
	SizeValue *int `bson:"size,omitempty" json:"size,omitempty"`

	// Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response. Defaults to true. (Optional)
	SourceValue *Source `bson:"_source,omitempty" json:"_source,omitempty"`

	// Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API (Optional).
	StatsValue []string `bson:"stats,omitempty" json:"stats,omitempty"`

	TerminateAfterValue *int `bson:"terminate_after,omitempty" json:"terminate_after,omitempty"`

	TimeoutValue *time.Duration `bson:"timeout,omitempty" json:"timeout,omitempty"`

	VersionValue *bool `bson:"version,omitempty" json:"version,omitempty"`
}

type SlopParam struct {
	SlopValue *int `json:"slop,omitempty" bson:"slop,omitempty"`
}

type Source struct {
	BoolValue       *bool                          `bson:"bool,omitempty" json:"-"`
	WildcardPattern dynamic.StringOrArrayOfStrings `bson:"wildcard,omitempty" json:"-"`
	Specifications  *SourceSpecifications
}

type SourceSpecifications struct {
	Includes dynamic.StringOrArrayOfStrings `bson:"includes,omitempty" json:"includes,omitempty"`
	Excludes dynamic.StringOrArrayOfStrings `bson:"excludes,omitempty" json:"excludes,omitempty"`
}

type Term struct {
	// Term you wish to find in the provided <field>. To return a document, the
	// term must exactly match the field value, including whitespace and
	// capitalization. (Required)
	Value                string `json:"value" bson:"value"`
	BoostParam           `json:",inline" bson:",inline"`
	CaseInsensitiveParam `json:",inline" bson:",inline"`
}

type TermQuery struct {
	Term map[string]Term `json:"term,omitempty" bson:"term,omitempty"`
}

type TranspositionsParam struct {
	TranspositionsValue *bool `json:"transpositions,omitempty" bson:"transpositions,omitempty"`
}

type WithAnalyzer interface {
	// Analyzer used to convert the text in the query value into tokens.
	// Defaults to the index-time analyzer mapped for the <field>. If no
	// analyzer is mapped, the index’s default analyzer is used. (Optional)
	Analyzer() string
	// SetAnalyzer sets the Analyzer value to v
	SetAnalyzer(v string)
}

type WithAutoGenerateSynonymsPhraseQuery interface {
	// AutoGenerateSynonymsPhraseQuery determines if match phrase queries are
	// automatically created for multi-term synonyms. Defaults to true.
	AutoGenerateSynonymsPhraseQuery() bool
	// SetAutoGenerateSynonymsPhraseQuery sets AutoGenerateSynonymsPhraseQueryValue to v
	SetAutoGenerateSynonymsPhraseQuery(v bool)
}

type WithBoost interface {
	Boost() float32
	SetBoost(v float32)
}

type WithFuzziness interface {
	// Fuzziness is the maximum edit distance allowed for matching. See
	// Fuzziness for valid values and more information. See Fuzziness in the
	// match query for an example.
	Fuzziness() string
	// SetFuzziness sets the FuzzinessValue to v
	SetFuzziness(str string)
	// FuzzyRewrite is the method used to rewrite the query. See the rewrite
	// parameter for valid values and more information.
	//
	// If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite
	// method of top_terms_blended_freqs_${max_expansions} by default.
	FuzzyRewrite() Rewrite
	// SetFuzzyRewrite sets the value of FuzzyRewrite to v
	SetFuzzyRewrite(v Rewrite)
}

type WithFuzzyTranspositions interface {
	// FuzzyTranspositions edits for fuzzy matching include transpositions of
	// two adjacent characters (ab → ba). Defaults to true
	FuzzyTranspositions() bool
	// SetFuzzyTranspositions sets FuzzyTranspositions to v
	SetFuzzyTranspositions(v bool)
}

type WithLenient interface {
	// Lenient determines whether format-based errors, such as providing a text
	// query value for a numeric field, are ignored. Defaults to false.
	Lenient() bool
	// SetLenient sets Lenient to v
	SetLenient(v bool)
}

type WithMaxExpansions interface {
	// MaxExpansions is the maximum number of variations created. Defaults to 50.
	MaxExpansions() int
	SetMaxExpansions(v int)
}

type WithMinimumShouldMatch interface {
	MinimumShouldMatch() string
	SetMinimumShouldMatch(v string)
}

type WithOperator interface {
	// Operator is the boolean logic used to interpret text in the query value.
	// Defaults to Or
	Operator() Operator
	// SetOperator sets the Operator to v
	SetOperator(v Operator)
}

type WithPrefixLength interface {
	PrefixLength() int
	SetPrefixLength(v int)
}

type WithRewrite interface {
	Rewrite() Rewrite
	SetRewrite(v Rewrite)
}

type WithSlop interface {
	Slop() int
	SetSlop(v int)
}

type WithTranspositions interface {
	// Transpositions indicates whether edits include transpositions of two
	// adjacent characters (ab → ba). Defaults to true.
	Transpositions() bool
	// SetTranspositions sets the value of Transpositions to v
	SetTranspositions(v bool)
}

type WithZeroTermsQuery interface {
	// ZeroTermsQuery indicates  whether no documents are returned if the
	// analyzer removes all tokens, such as when using a stop filter
	ZeroTermsQuery() ZeroTermsQuery
	SetZeroTermsQuery(v ZeroTermsQuery)
}

type ZeroTermsQuery string

type ZeroTermsQueryParam struct {
	ZeroTermsQueryValue *ZeroTermsQuery `json:"zero_terms_query,omitempty" bson:"zero_terms_query,omitempty"`
}