Package com.azure.search.documents

Class SearchFilter

java.lang.Object

com.azure.search.documents.SearchFilter

public final class SearchFilter
extends Object

This class is used to help construct valid OData filter expressions by automatically replacing, quoting, and escaping string parameters.

The constructed OData filter expression is used by AutocompleteOptions.setFilter(String), SearchOptions.setFilter(String), and SuggestOptions.setFilter(String).

For more information, see Filters in Azure Cognitive Search.

Method Summary

Modifier and Type	Method	Description
static String	create(String formattableString, Object... args)	Create an OData filter expression from a formattable string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static String create(String formattableString,
 Object... args)

Create an OData filter expression from a formattable string.

The format argument values will be quoted and escaped as necessary.

Parameters:

formattableString - The formattable string.

args - The arguments for the formattable string.

Returns:

A valid OData filter expression.