# -*- mode: qore; indent-tabs-mode: nil -*-
#! Qore ElasticSearchDataProvider module definition

/** ElasticSearchIndexDataTypeBase.qc Copyright 2023 Qore Technologies, s.r.o.

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

#! Contains all public definitions in the ElasticSearchDataProvider module
public namespace ElasticSearchDataProvider {
#! Base data type for search request types
public class ElasticSearchIndexDataTypeBase inherits DataProvider::HashDataType {
    private {
        #! Field descriptions
        const Fields = {
            # body parameters
            "filter": {
                "type": AutoHashOrNothingType,
                "desc": "Query used to limit documents the alias can access",
            },
            "index_routing": {
                "type": StringOrNothingType,
                "desc": "Value used to route indexing operations to a specific shard. If specified, this overwrites "
                    "the `routing` value for indexing operations",
            },
            "is_hidden": {
                "type": SoftBoolStringType,
                "desc": "If `true`, the alias is hidden. Defaults to `false`. All indices for the alias must have the "
                    "same `is_hidden` value",
            },
            "is_write_index": {
                "type": SoftBoolStringType,
                "desc": "If `true`, the index is the write index for the alias. Defaults to `false`",
            },
            "routing": {
                "type": StringOrNothingType,
                "desc": "Value used to route indexing and search operations to a specific shard",
            },
            "search_routing": {
                "type": StringOrNothingType,
                "desc": "Value used to route search operations to a specific shard. If specified, this overwrites "
                    "the `routing` value for search operations",
            },
        };
    }

    #! Creates the object
    constructor() {
        map addField(new QoreDataField($1.key, $1.value.desc, $1.value.type, $1.value.default_value)),
            Fields.pairIterator();
    }
}
}