com.atlan.model.fields.IBooleanSearchable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atlan-java Show documentation

Atlan Java SDK

There is a newer version: 4.2.1

/* SPDX-License-Identifier: Apache-2.0
   Copyright 2023 Atlan Pte. Ltd. */
package com.atlan.model.fields;

import co.elastic.clients.elasticsearch._types.query_dsl.Query;
import co.elastic.clients.elasticsearch._types.query_dsl.TermQuery;

public interface IBooleanSearchable {
    /**
     * Returns the name of the boolean field index for this attribute in Elastic.
     *
     * @return the field name for the boolean index on this attribute
     */
    String getBooleanFieldName();

    /**
     * Returns a query that will match all assets whose provided field has a value that exactly equals
     * the provided boolean value.
     *
     * @param value the value (boolean) to check the field's value is exactly equal to
     * @return a query that will only match assets whose value for the field is exactly equal to the boolean value provided
     */
    Query eq(boolean value);

    /**
     * Returns a query that will match all assets whose provided field has a value that exactly equals
     * the provided boolean value.
     *
     * @param field name of the field to search
     * @param value the value (boolean) to check the field's value is exactly equal to
     * @return a query that will only match assets whose value for the field is exactly equal to the boolean value provided
     */
    static Query eq(final String field, final boolean value) {
        return TermQuery.of(t -> t.field(field).value(value))._toQuery();
    }
}