* This will be used by the **automatic docs**.
    * It will also be used by automatic client code generation tools.

But most importantly:

* It will **limit and filter** the output data to what is defined in the return type.
    * This is particularly important for **security**, we'll see more of that below.

## `response_model` Parameter { #response-model-parameter }

		<property name="dataIndex">"fess_crawler.data"</property>
		<property name="dataShards">5</property>
		<property name="dataReplicas">1</property>
		<property name="filterIndex">"fess_crawler.filter"</property>
		<property name="filterShards">5</property>
		<property name="filterReplicas">1</property>
	</component>

    Iterator<String> filtered = filter(unfiltered, equalTo("foo"));
    List<String> expected = singletonList("foo");
    List<String> actual = Lists.newArrayList(filtered);
    assertEquals(expected, actual);
  }

  public void testFilterNoMatch() {
    Iterator<String> unfiltered = Lists.newArrayList("foo", "bar").iterator();
    Iterator<String> filtered = filter(unfiltered, Predicates.alwaysFalse());

import org.codelibs.fess.opensearch.config.cbean.cq.ElevateWordToLabelCQ;
import org.codelibs.fess.opensearch.config.cbean.cq.bs.BsElevateWordToLabelCQ;
import org.opensearch.search.aggregations.bucket.filter.FilterAggregationBuilder;
import org.opensearch.search.aggregations.bucket.global.GlobalAggregationBuilder;
import org.opensearch.search.aggregations.bucket.missing.MissingAggregationBuilder;

     * This method applies various filter conditions based on the pager parameters
     * including name, paths, and description filters with wildcard and phrase matching.
     *
     * @param cb the condition bean for building the database query
     * @param fileConfigPager the pager containing search filter criteria
     */

"""
            if (performanceTestProject.performanceTests.any { it.testProjects.isNotEmpty() }) {
                val dependencyBuildIds =
                    performanceTestProject.performanceTests
                        .filter { it.testProjects.isNotEmpty() }
                        .joinToString(",") { "%dep.${it.id}.env.BUILD_ID%" }

                val dependencyBaselines =
                    performanceTestProject.performanceTests

        }

        return resultBuf.toString();
    }

    /**
     * Sets the query builder for filtering documents.
     *
     * @param queryBuilder the query builder to filter documents
     * @return this UpdateLabelJob instance for method chaining
     */
    public UpdateLabelJob query(final QueryBuilder queryBuilder) {
        this.queryBuilder = queryBuilder;
        return this;

     * @return An optional entity of the Kuromoji file.
     */
    public OptionalEntity<KuromojiFile> getKuromojiFile(final String dictId) {
        return dictionaryManager.getDictionaryFile(dictId)
                .filter(KuromojiFile.class::isInstance)
                .map(file -> OptionalEntity.of((KuromojiFile) file))
                .orElse(OptionalEntity.empty());
    }

    /**
     * Get a Kuromoji item.
     *

	if hasStringSuffixInSlice(objStr, standardExcludeCompressExtensions) || hasPattern(standardExcludeCompressContentTypes, contentType) {
		return true
	}

	// Filter compression includes.
	if len(cfg.Extensions) == 0 && len(cfg.MimeTypes) == 0 {
		// Nothing to filter, include everything.
		return false
	}

	if len(cfg.Extensions) > 0 && hasStringSuffixInSlice(objStr, cfg.Extensions) {

{* ../../docs_src/response_headers/tutorial002.py hl[1, 7:8] *}

And then you can return any object you need, as you normally would (a `dict`, a database model, etc).

And if you declared a `response_model`, it will still be used to filter and convert the object you returned.