query_constant_score.go

// Modified by DefenseStation on 2024-06-06
// Changes: Updated ElasticSearch client to OpenSearch client, changed package name to 'osquery',
// updated references to OpenSearch documentation, and modified examples accordingly.

package osquery

import "github.com/fatih/structs"

// ConstantScoreQuery represents a compound query of type "constant_score", as
// described in
// https://opensearch.org/docs/latest/query-dsl/compound/constant-score/
type ConstantScoreQuery struct {
	filter Mappable
	boost  float32
	name   string
}

// ConstantScore creates a new query of type "constant_score" with the provided
// filter query.
func ConstantScore(filter Mappable) *ConstantScoreQuery {
	return &ConstantScoreQuery{
		filter: filter,
	}
}

// Boost sets the boost value of the query.
func (q *ConstantScoreQuery) Boost(b float32) *ConstantScoreQuery {
	q.boost = b
	return q
}

// Name sets the name of the query that is returned in matched_queries in response
// if document matches the query.
func (q *ConstantScoreQuery) Name(name string) *ConstantScoreQuery {
	q.name = name
	return q
}

// Map returns a map representation of the query, thus implementing the
// Mappable interface.
func (q *ConstantScoreQuery) Map() map[string]interface{} {
	return map[string]interface{}{
		"constant_score": structs.Map(struct {
			Filter map[string]interface{} `structs:"filter"`
			Boost  float32                `structs:"boost,omitempty"`
			Name   string                 `structs:"_name,omitempty"`
		}{q.filter.Map(), q.boost, q.name}),
	}
}