Spring Data Elasticsearch

https://docs.spring.io/spring-data/elasticsearch/docs/current/
Admin
Spring Data Elasticsearch provides integration with the Elasticsearch search engine, offering a...
Tokens:465,784
Snippets:4,838
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### findAll

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/querybyexample/QueryByExampleElasticsearchExecutor.html

Retrieves all entities matching the given example.

```APIDOC
## findAll(Example<S> example)

### Description
Retrieves all entities matching the given `Example`.

### Parameters
#### Path Parameters
- **example** (Example<S>) - The example to match entities against.

### Returns
An `Iterable` of matching entities.
```

--------------------------------

### getSettings()

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Get the settings for the index. Returns a Mono with a Document containing the index settings.

```APIDOC
## getSettings

### Description
Get the settings for the index.

### Parameters
- None

### Response
#### Success Response (Mono<Settings>)
- A Mono with a `Document` containing the index settings.

#### Response Example
```json
{
  "index": {
    "number_of_shards": 1,
    "number_of_replicas": 0
  }
}
```
```

--------------------------------

### findAll Methods

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Methods for retrieving all entities, with or without examples, pagination, or sorting.

```APIDOC
## findAll(Example)

### Description
Retrieves all entities matching the given example.

### Method
`findAll`

### Endpoint
N/A (Method Signature)

### Parameters
- **Example** (Example): The example object to query by.
```

```APIDOC
## findAll(Example, Pageable)

### Description
Retrieves a page of entities matching the given example.

### Method
`findAll`

### Endpoint
N/A (Method Signature)

### Parameters
- **Example** (Example): The example object to query by.
- **Pageable** (Pageable): The pagination information.
```

```APIDOC
## findAll(Example, Sort)

### Description
Retrieves all entities matching the given example, sorted according to the provided Sort object.

### Method
`findAll`

### Endpoint
N/A (Method Signature)

### Parameters
- **Example** (Example): The example object to query by.
- **Sort** (Sort): The sorting information.
```

```APIDOC
## findAll(Pageable)

### Description
Retrieves a page of all entities.

### Method
`findAll`

### Endpoint
N/A (Method Signature)

### Parameters
- **Pageable** (Pageable): The pagination information.
```

```APIDOC
## findAll(Sort)

### Description
Retrieves all entities, sorted according to the provided Sort object.

### Method
`findAll`

### Endpoint
N/A (Method Signature)

### Parameters
- **Sort** (Sort): The sorting information.
```

--------------------------------

### Exists by Example

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Check for existence based on an example.

```APIDOC
## exists(Example)

### Description
Check for existence based on an example.

### Method
Not specified (likely Java method call)

### Endpoint
N/A

### Parameters
- **example** (Example) - Required - The example to search by.
```

--------------------------------

### Create ClientConfiguration from Host and Port String

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/ClientConfiguration.html

Use `ClientConfiguration.create(String)` to configure the client with a single host specified as a string (e.g., "localhost:9200").

```java
ClientConfiguration configuration = ClientConfiguration.create("localhost:9200");
```

--------------------------------

### Highlight Class Constructor with Parameters and Fields

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/highlight/class-use/HighlightField.html

Demonstrates the constructor for the Highlight class that accepts both HighlightParameters and a list of HighlightField objects.

```APIDOC
## Highlight(HighlightParameters parameters, List<HighlightField> fields)

### Description
Constructs a Highlight object with the specified highlight parameters and a list of highlight fields.

### Constructor Parameters
* **parameters** (HighlightParameters) - The highlight parameters.
* **fields** (List<HighlightField>) - The list of fields to highlight.
```

--------------------------------

### Get Mapping

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/IndicesTemplate.html

Gets the mapping for an index defined by a class.

```APIDOC
## getMapping

### Description
Get mapping for an index defined by a class.

### Method
`Map<String, Object> getMapping()`

### Returns
the mapping
```

--------------------------------

### TermSuggestion.Entry.Option Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/suggest/response/TermSuggestion.Entry.Option.html

Initializes a new instance of the TermSuggestion.Entry.Option class.

```APIDOC
## Constructor

`Option(String text, @Nullable String highlighted, double score, @Nullable Boolean collateMatch, int freq)`

### Description

Constructs an Option with the given text, highlighted version, score, collate match status, and frequency.
```

--------------------------------

### Get Mapping

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveIndicesTemplate.html

Gets the mapping for the index targeted by this ReactiveIndexOperations. Returns the mapping.

```APIDOC
## getMapping

### Description
Get mapping for the index targeted defined by this `ReactiveIndexOperations`

### Method
```java
public Mono<Document> getMapping()
```

### Returns
the mapping
```

--------------------------------

### Create ClientConfiguration from Host and Port String

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/ClientConfiguration.html

Creates a new ClientConfiguration instance configured to a single host specified by a host and port string.

```APIDOC
## create

### Description
Creates a new `ClientConfiguration` instance configured to a single host given `hostAndPort`. For example given the endpoint http://localhost:9200

### Example
```java
ClientConfiguration configuration = ClientConfiguration.create("localhost:9200");
```

### Method
`static ClientConfiguration create(String hostAndPort)

### Returns
a new `ClientConfigurationBuilder` instance.
```

--------------------------------

### getComponentTemplate

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Get component template(s).

```APIDOC
## getComponentTemplate 
Flux<TemplateResponse> getComponentTemplate(GetComponentTemplateRequest getComponentTemplateRequest)

### Description
Get component template(s).

### Parameters
#### Request Body
- `getComponentTemplateRequest` (GetComponentTemplateRequest) - the getComponentTemplateRequest parameters

### Returns
- Flux<TemplateResponse> - a `Flux` of `TemplateResponse`
```

--------------------------------

### CompletionSuggestion.Entry Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/suggest/response/CompletionSuggestion.Entry.html

This constructor initializes a new instance of the CompletionSuggestion.Entry class with the provided text, offset, length, and a list of options.

```APIDOC
## CompletionSuggestion.Entry Constructor

### Description
Initializes a new instance of the `CompletionSuggestion.Entry` class.

### Signature
`public Entry(String text, int offset, int length, List<CompletionSuggestion.Entry.Option<T>> options)`

### Parameters
* **text** (String) - The text of the suggestion entry.
* **offset** (int) - The offset of the suggestion entry.
* **length** (int) - The length of the suggestion entry.
* **options** (List<CompletionSuggestion.Entry.Option<T>>) - A list of options associated with the suggestion entry.
```

--------------------------------

### getIndexTemplate

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/IndicesTemplate.html

Gets an index template.

```APIDOC
## getIndexTemplate

### Description
Gets an index template.

### Method
```java
public List<TemplateResponse> getIndexTemplate(GetIndexTemplateRequest getIndexTemplateRequest)
```

### Parameters
- **getIndexTemplateRequest** (GetIndexTemplateRequest) - The request parameters.
```

--------------------------------

### create(Map<String, @Nullable Object> settings)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Create an index with the specified settings. Returns a Mono signalling successful operation completion or an error if the index already exists.

```APIDOC
## create

### Description
Create an index with the specified settings.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **settings** (Map<String, @Nullable Object>) - index settings

### Request Example
```json
{
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 0
  }
}
```

### Response
#### Success Response (Mono<Boolean>)
- A Mono signalling successful operation completion.

#### Response Example
```json
{
  "acknowledged": true
}
```
```

--------------------------------

### getEntityRouting

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveElasticsearchOperations.html

Gets the routing for an entity.

```APIDOC
## getEntityRouting

### Description
Gets the routing for an entity.

### Parameters
* `entity` - The entity to get the routing for.

### Returns
The routing string, may be null if not set.

### Since
5.2
```

--------------------------------

### SearchPage Creation from SearchHits

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/class-use/SearchPage.html

Demonstrates how to create a SearchPage from SearchHits using the `searchPageFor` static method.

```APIDOC
## `searchPageFor`

### Description
Creates a `SearchPage` from `SearchHits` and an optional `Pageable`.

### Method Signature
`static <T> SearchPage<T> searchPageFor(SearchHits<T> searchHits, @Nullable Pageable pageable)`

### Parameters
* `searchHits` (SearchHits<T>) - The search results to paginate.
* `pageable` (Pageable) - Optional pagination information.
```

--------------------------------

### Info

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html

Gets cluster information.

```APIDOC
## info

Gets cluster information.

### Method
`Mono<InfoResponse> info()`

### Request Example
```java
// Example usage for info operation
```

### Response
* `InfoResponse` - The response containing cluster information.
```

--------------------------------

### Get Script

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html

Retrieves a script.

```APIDOC
## getScript

Retrieves a script.

### Method
`Mono<GetScriptResponse> getScript(GetScriptRequest request)`

### Parameters
* `request` (GetScriptRequest) - The get script request object.

### Request Example
```java
// Example usage for getScript operation
```

### Response
* `GetScriptResponse` - The response containing the script.
```

```APIDOC
## getScript with builder

Retrieves a script using a builder function.

### Method
`Mono<GetScriptResponse> getScript(Function<GetScriptRequest.Builder, ObjectBuilder<GetScriptRequest>> fn)`

### Parameters
* `fn` (Function<GetScriptRequest.Builder, ObjectBuilder<GetScriptRequest>>) - A function that builds the get script request.

### Request Example
```java
// Example usage for getScript operation with builder
```

### Response
* `GetScriptResponse` - The response containing the script.
```

--------------------------------

### Create ClientConfiguration for Localhost

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/ClientConfiguration.html

Use `ClientConfiguration.localhost()` to create a configuration pointing to localhost on the default port.

```java
ClientConfiguration configuration = ClientConfiguration.localhost();
```

--------------------------------

### Get

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html

Retrieves a document by its ID.

```APIDOC
## get

Retrieves a document by its ID.

### Method
`<T> Mono<GetResponse<T>> get(GetRequest request, Class<T> tClass)`

### Parameters
* `request` (GetRequest) - The get request object.
* `tClass` (Class<T>) - The class to deserialize the document into.

### Request Example
```java
// Example usage for get operation
```

### Response
* `GetResponse<T>` - The response containing the retrieved document.
```

```APIDOC
## get with builder

Retrieves a document by its ID using a builder function.

### Method
`<T> Mono<GetResponse<T>> get(Function<GetRequest.Builder, ObjectBuilder<GetRequest>> fn, Class<T> tClass)`

### Parameters
* `fn` (Function<GetRequest.Builder, ObjectBuilder<GetRequest>>) - A function that builds the get request.
* `tClass` (Class<T>) - The class to deserialize the document into.

### Request Example
```java
// Example usage for get operation with builder
```

### Response
* `GetResponse<T>` - The response containing the retrieved document.
```

--------------------------------

### Localhost Configuration

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/ClientConfiguration.html

Creates a new ClientConfiguration instance specifically configured to connect to localhost.

```APIDOC
## localhost

### Description
Creates a new `ClientConfiguration` instance configured to localhost.

### Example
```java
// "localhost:9200"
ClientConfiguration configuration = ClientConfiguration.localhost();
```

### Method
`static ClientConfiguration localhost()

### Returns
a new `ClientConfiguration` instance.

### See Also
* `ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint.connectedToLocalhost()`
```

--------------------------------

### ReactiveQueryByExampleElasticsearchExecutor Methods

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/querybyexample/ReactiveQueryByExampleElasticsearchExecutor.html

This section details the methods available for executing queries by example reactively.

```APIDOC
## findOne

### Description
Finds a single entity matching the given example.

### Method
`Mono<S> findOne(Example<S> example)`

### Parameters
* **example** (Example<S>) - The example to match entities against.

### Return Value
A Mono emitting the found entity, or an empty Mono if none is found.
```

```APIDOC
## findAll

### Description
Finds all entities matching the given example.

### Method
`Flux<S> findAll(Example<S> example)`

### Parameters
* **example** (Example<S>) - The example to match entities against.

### Return Value
A Flux emitting all found entities.
```

```APIDOC
## findAll

### Description
Finds all entities matching the given example with sorting.

### Method
`Flux<S> findAll(Example<S> example, Sort sort)`

### Parameters
* **example** (Example<S>) - The example to match entities against.
* **sort** (Sort) - The sorting to apply to the results.

### Return Value
A Flux emitting all found entities, sorted according to the provided Sort object.
```

```APIDOC
## count

### Description
Counts the number of entities matching the given example.

### Method
`Mono<Long> count(Example<S> example)`

### Parameters
* **example** (Example<S>) - The example to match entities against.

### Return Value
A Mono emitting the count of matching entities.
```

```APIDOC
## exists

### Description
Checks if any entity matching the given example exists.

### Method
`Mono<Boolean> exists(Example<S> example)`

### Parameters
* **example** (Example<S>) - The example to match entities against.

### Return Value
A Mono emitting true if at least one matching entity exists, false otherwise.
```

```APIDOC
## findBy

### Description
Executes a query based on the given example and a function that defines the query structure.

### Method
`<R, P extends Publisher<R>> P findBy(Example<S> example, Function<FluentQuery.ReactiveFluentQuery<S>, P> queryFunction)`

### Parameters
* **example** (Example<S>) - The example to match entities against.
* **queryFunction** (Function<FluentQuery.ReactiveFluentQuery<S>, P>) - A function that builds the query using a reactive fluent query builder.

### Return Value
A Publisher emitting the query results.
```

--------------------------------

### Timeout

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/BaseQuery.html

Set and get the query timeout.

```APIDOC
## getTimeout

### Description
Get the query timeout.

### Method
`public @Nullable Duration getTimeout()`

### Returns
The query timeout duration, or null if not set.
```

```APIDOC
## setTimeout

### Description
Set the query timeout.

### Method
`public void setTimeout(@Nullable Duration timeout)`

### Parameters
* `timeout` (@Nullable Duration) - The timeout duration to set.

### Since
4.2
```

--------------------------------

### Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/SimpleReactiveElasticsearchRepository.html

Initializes a new instance of the SimpleReactiveElasticsearchRepository.

```APIDOC
## Constructor Details
### SimpleReactiveElasticsearchRepository
public SimpleReactiveElasticsearchRepository(ElasticsearchEntityInformation<T,ID> entityInformation, ReactiveElasticsearchOperations operations)
```

--------------------------------

### create(Map<String, @Nullable Object> settings, Document mapping)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Create an index for given settings and mapping. Returns a Mono signalling successful operation completion or an error if the index already exists.

```APIDOC
## create

### Description
Create an index for given settings and mapping.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **settings** (Map<String, @Nullable Object>) - the index settings
- **mapping** (Document) - the index mapping

### Request Example
```json
{
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 0
  },
  "mappings": {
    "properties": {
      "field1": {"type": "text"}
    }
  }
}
```

### Response
#### Success Response (Mono<Boolean>)
- A Mono signalling successful operation completion.

#### Response Example
```json
{
  "acknowledged": true
}
```
```

--------------------------------

### Get Operation

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/DocumentOperations.html

Retrieves a document by its ID.

```APIDOC
## get

### Description
Retrieves an object from the index.

### Method
`<T> @Nullable T get(String id, Class<T> clazz)`

### Method
`<T> @Nullable T get(String id, Class<T> clazz, IndexCoordinates index)`
```

--------------------------------

### getInformation()

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Gets the IndexInformation for the indices defined by ReactiveIndexOperations.getIndexCoordinates().

```APIDOC
## getInformation()

### Description
Gets the `IndexInformation` for the indices defined by `ReactiveIndexOperations.getIndexCoordinates()`.

### Method
Interface method (specific HTTP method not detailed in source)

### Endpoint
Not explicitly defined, likely internal to the Elasticsearch client.

### Response
#### Success Response
- **IndexInformation** - The index information object.
```

--------------------------------

### getIndexTemplate(String)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Gets an index template by its name.

```APIDOC
## getIndexTemplate(String)

### Description
Gets an index template by its name.

### Method
Interface method (specific HTTP method not detailed in source)

### Endpoint
Not explicitly defined, likely internal to the Elasticsearch client.

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the index template to retrieve.

### Response
#### Success Response
- **IndexTemplate** - The retrieved index template object.
```

--------------------------------

### Creating a PutIndexTemplateRequest.Builder

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/index/class-use/PutIndexTemplateRequest.Builder.html

Demonstrates how to obtain an instance of the PutIndexTemplateRequest.Builder.

```APIDOC
## Creating a PutIndexTemplateRequest Builder

To start building a `PutIndexTemplateRequest`, you first need to obtain a `Builder` instance.

### Method

`static PutIndexTemplateRequest.Builder builder()`

### Description

This static method returns a new instance of `PutIndexTemplateRequest.Builder`, which can then be used to configure and construct a `PutIndexTemplateRequest`.
```

--------------------------------

### ReindexRequest.Source getIndexes

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/mapping/class-use/IndexCoordinates.html

Gets the IndexCoordinates for the source of a ReindexRequest.

```APIDOC
## IndexCoordinates getIndexes()

### Description
Gets the IndexCoordinates for the source of this reindex request.

### Method
Instance Method

### Returns
- **IndexCoordinates** - The source index coordinates.
```

--------------------------------

### KebabCaseFieldNamingStrategy Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/mapping/KebabCaseFieldNamingStrategy.html

Initializes a new instance of the KebabCaseFieldNamingStrategy class.

```APIDOC
## KebabCaseFieldNamingStrategy()

### Description
Initializes a new instance of the KebabCaseFieldNamingStrategy class.

### Constructor
`public KebabCaseFieldNamingStrategy()`
```

--------------------------------

### ReindexRequest.Dest getIndex

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/mapping/class-use/IndexCoordinates.html

Gets the IndexCoordinates for the destination of a ReindexRequest.

```APIDOC
## IndexCoordinates getIndex()

### Description
Gets the IndexCoordinates for the destination of this reindex request.

### Method
Instance Method

### Returns
- **IndexCoordinates** - The destination index coordinates.
```

--------------------------------

### Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/support/HttpHeaders.html

Initializes a new instance of the HttpHeaders class.

```APIDOC
## Constructor HttpHeaders()

### Description
Initializes a new instance of the HttpHeaders class.
```

--------------------------------

### HighlightParameters Builder Methods

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/highlight/class-use/HighlightParameters.HighlightParametersBuilder.html

Demonstrates how to create and configure HighlightParameters using its builder.

```APIDOC
## HighlightParameters Builder

### Description
Provides a fluent API for constructing `HighlightParameters` objects.

### Methods

#### `static HighlightParameters.HighlightParametersBuilder builder()`

Creates a new `HighlightParametersBuilder` instance.

#### `HighlightParameters.HighlightParametersBuilder withEncoder(String encoder)`

Sets the encoder to be used for highlighting.

- **encoder** (String) - The name of the encoder.

#### `HighlightParameters.HighlightParametersBuilder withTagsSchema(String tagsSchema)`

Sets the tags schema to be used for highlighting.

- **tagsSchema** (String) - The name of the tags schema.
```

--------------------------------

### Preference

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/BaseQuery.html

Set and get the preference for search requests.

```APIDOC
## getPreference

### Description
Get preference.

### Method
`public @Nullable String getPreference()`

### Returns
The preference string, or null if not set.
```

```APIDOC
## setPreference

### Description
Add preference filter to be added as part of search request.

### Method
`public void setPreference(String preference)`

### Parameters
* `preference` (String) - The preference string to set.
```

--------------------------------

### HighlightField Constructor with Parameters

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/highlight/class-use/HighlightFieldParameters.html

Illustrates creating a HighlightField with specific highlight parameters.

```APIDOC
## HighlightField(String name, HighlightFieldParameters parameters)

### Description
Constructs a new HighlightField with the given name and highlight parameters.

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the field to highlight.
- **parameters** (HighlightFieldParameters) - Required - The parameters for highlighting this field.
```

--------------------------------

### Route

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/BaseQuery.html

Methods for setting and getting the route for a search.

```APIDOC
## getRoute

### Description
Gets the route value for the search.

### Method
`getRoute()`

### Returns
`@Nullable String` - The route value, or null if not set.

## setRoute

### Description
Sets the route for the search.

### Method
`setRoute(String route)`

### Parameters
- `route` (String) - The route value to set.
```

--------------------------------

### Configuration and Callbacks

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchTemplate.html

Methods for configuring observation conventions and setting the application context.

```APIDOC
## setApplicationContext(ApplicationContext applicationContext)

### Description
Sets the `ApplicationContext` for the template.

### Method
Not specified (likely internal setter)

### Endpoint
N/A

### Parameters
* **applicationContext** (ApplicationContext) - The `ApplicationContext` to set.

### Response
* **void**
```

```APIDOC
## setObservationConvention(@Nullable ElasticsearchObservationConvention observationConvention)

### Description
Sets a custom `ElasticsearchObservationConvention` to override the default convention.

### Method
Not specified (likely internal setter)

### Endpoint
N/A

### Parameters
* **observationConvention** (@Nullable ElasticsearchObservationConvention) - The custom observation convention to set.

### Response
* **void**
```

--------------------------------

### Query Timeout

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/Query.html

Get the query timeout duration.

```APIDOC
## getTimeout

### Description
Get the query timeout.

### Method
@Nullable Duration

### Returns
null if not set.

### Since
4.2
```

--------------------------------

### Creating ReactiveElasticsearchClient

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/class-use/ReactiveElasticsearchClient.html

Demonstrates various ways to create an instance of ReactiveElasticsearchClient using different configurations and transports.

```APIDOC
## Creating ReactiveElasticsearchClient

This section details the static factory methods available in `ElasticsearchClients` for creating `ReactiveElasticsearchClient` instances.

### `ElasticsearchClients.createReactive(ElasticsearchTransport transport)`
Creates a new `ReactiveElasticsearchClient` that uses the given `ElasticsearchTransport`.

### `ElasticsearchClients.createReactive(Rest5Client rest5Client)`
Creates a new `ReactiveElasticsearchClient`.

### `ElasticsearchClients.createReactive(Rest5Client rest5Client, @Nullable TransportOptions transportOptions, JsonpMapper jsonpMapper)`
Creates a new `ReactiveElasticsearchClient`.

### `ElasticsearchClients.createReactive(ClientConfiguration clientConfiguration)`
Creates a new `ReactiveElasticsearchClient`.

### `ElasticsearchClients.createReactive(ClientConfiguration clientConfiguration, @Nullable TransportOptions transportOptions)`
Creates a new `ReactiveElasticsearchClient`.

### `ElasticsearchClients.createReactive(ClientConfiguration clientConfiguration, @Nullable TransportOptions transportOptions, JsonpMapper jsonpMapper)`
Creates a new `ReactiveElasticsearchClient`.

### Deprecated Methods (use with caution):

### `ElasticsearchClients.createReactive(RestClient restClient)`
Deprecated, for removal: This API element is subject to removal in a future version.
since 6.0, use the version with a Rest5Client.

### `ElasticsearchClients.createReactive(RestClient restClient, @Nullable TransportOptions transportOptions, JsonpMapper jsonpMapper)`
Deprecated, for removal: This API element is subject to removal in a future version.
since 6.0, use the version with a Rest5Client.

### `ReactiveElasticsearchConfiguration.reactiveElasticsearchClient(ElasticsearchTransport transport)`
Provides the `ReactiveElasticsearchClient` instance used.

### `ReactiveElasticsearchLegacyRestClientConfiguration.reactiveElasticsearchClient(ElasticsearchTransport transport)`
Deprecated, for removal: This API element is subject to removal in a future version.
Provides the `ReactiveElasticsearchClient` instance used.
```

--------------------------------

### getInformation ()

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Gets the IndexInformation for the indices defined by getIndexCoordinates().

```APIDOC
## getInformation ()

### Description
Gets the `IndexInformation` for the indices defined by `getIndexCoordinates()`.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Returns
Flux<IndexInformation> - A flux of `IndexInformation`.

### Since
4.2
```

--------------------------------

### create(Map<String, @Nullable Object> settings, Document mapping)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/IndexOperations.html

Creates an index with the specified settings and mapping. Returns true if the index was successfully created.

```APIDOC
## create
boolean create(Map<String, @Nullable Object> settings, Document mapping)

### Description
Create an index for given settings and mapping.

### Parameters
* `settings` - the index settings
* `mapping` - the index mapping

### Returns
* `true` if the index was created

### Since
4.2
```

--------------------------------

### getIndexTemplate (by name)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Get index template(s) by name.

```APIDOC
## getIndexTemplate 
default Flux<TemplateResponse> getIndexTemplate(String indexTemplateName)

### Description
Get index template(s).

### Parameters
#### Path Parameters
- `indexTemplateName` (String) - the name of the index template

### Returns
- Flux<TemplateResponse> - a `Flux` of `TemplateResponse`
```

--------------------------------

### ClientConfiguration.TerminalClientConfigurationBuilder.withClientConfigurer()

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/class-use/ClientConfiguration.ClientConfigurationCallback.html

Registers a callback to configure the client.

```APIDOC
## ClientConfiguration.TerminalClientConfigurationBuilder.withClientConfigurer(ClientConfiguration.ClientConfigurationCallback<?> clientConfigurer)

### Description
Registers a `ClientConfiguration.ClientConfigurationCallback` to customize the client configuration.

### Method
`withClientConfigurer(ClientConfiguration.ClientConfigurationCallback<?> clientConfigurer)`

### Parameters
#### Path Parameters
- **clientConfigurer** (`ClientConfiguration.ClientConfigurationCallback<?>`) - Required - The callback to register for client configuration.
```

--------------------------------

### exists

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/querybyexample/QueryByExampleElasticsearchExecutor.html

Checks if any entity matching the given example exists.

```APIDOC
## exists(Example<S> example)

### Description
Checks if an entity matching the given `Example` exists.

### Parameters
#### Path Parameters
- **example** (Example<S>) - The example to match entities against.

### Returns
`true` if at least one matching entity exists, `false` otherwise.
```

--------------------------------

### HighlightParameters Builder

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/highlight/class-use/HighlightParameters.html

Demonstrates how to build HighlightParameters using its builder.

```APIDOC
## HighlightParameters.HighlightParametersBuilder.build()

### Description
Builds an instance of HighlightParameters.

### Method
`build()`

### Returns
`HighlightParameters` - The constructed HighlightParameters object.
```

--------------------------------

### count

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/querybyexample/QueryByExampleElasticsearchExecutor.html

Counts the number of entities matching the given example.

```APIDOC
## count(Example<S> example)

### Description
Counts the number of entities matching the given `Example`.

### Parameters
#### Path Parameters
- **example** (Example<S>) - The example to match entities against.

### Returns
The total count of matching entities.
```

--------------------------------

### Building Client Configuration

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/ClientConfiguration.TerminalClientConfigurationBuilder.html

This snippet demonstrates how to use the TerminalClientConfigurationBuilder to construct a ClientConfiguration object.

```APIDOC
## build()

### Description
Build the `ClientConfiguration` object.

### Method
`ClientConfiguration`

### Returns
- `ClientConfiguration`: The fully configured client configuration object.
```

--------------------------------

### findOne

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/querybyexample/QueryByExampleElasticsearchExecutor.html

Retrieves a single entity matching the given example.

```APIDOC
## findOne(Example<S> example)

### Description
Finds a single instance of the domain class matching the given `Example`.

### Parameters
#### Path Parameters
- **example** (Example<S>) - The example to match entities against.

### Returns
An `Optional` containing the found entity, or an empty `Optional` if none was found.
```

--------------------------------

### Highlight Class Constructor with Fields

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/highlight/class-use/HighlightField.html

Illustrates the constructor for the Highlight class that accepts a list of HighlightField objects.

```APIDOC
## Highlight(List<HighlightField> fields)

### Description
Constructs a Highlight object with the specified list of highlight fields.

### Constructor Parameters
* **fields** (List<HighlightField>) - The list of fields to highlight.
```

--------------------------------

### getInformation(IndexCoordinates)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Gets the IndexInformation for the indices defined by ReactiveIndexOperations.getIndexCoordinates().

```APIDOC
## getInformation(IndexCoordinates)

### Description
Gets the `IndexInformation` for the indices defined by `ReactiveIndexOperations.getIndexCoordinates()`.

### Method
Interface method (specific HTTP method not detailed in source)

### Endpoint
Not explicitly defined, likely internal to the Elasticsearch client.

### Parameters
#### Path Parameters
- **indexCoordinates** (IndexCoordinates) - Required - The coordinates of the index for which to retrieve information.

### Response
#### Success Response
- **IndexInformation** - The index information object.
```

--------------------------------

### AbstractQueryProcessor Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/AbstractQueryProcessor.html

Initializes a new instance of the AbstractQueryProcessor class.

```APIDOC
## Constructor

### `AbstractQueryProcessor()`

Initializes a new instance of the `AbstractQueryProcessor` class.
```

--------------------------------

### getInformation(IndexCoordinates)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Gets the IndexInformation for the indices defined by index.

```APIDOC
## getInformation(IndexCoordinates)

### Description
Gets the `IndexInformation` for the indices defined by #index.

### Method
Interface method (specific HTTP method not detailed in source)

### Endpoint
Not explicitly defined, likely internal to the Elasticsearch client.

### Parameters
#### Path Parameters
- **indexCoordinates** (IndexCoordinates) - Required - The coordinates of the index for which to retrieve information.

### Response
#### Success Response
- **IndexInformation** - The index information object.
```

--------------------------------

### getAliasesForIndex(String...) - ReactiveIndexOperations

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

gets information about aliases

```APIDOC
## getAliasesForIndex(String...)

### Description
Gets information about aliases for the specified index names asynchronously.

### Method
Method

### Endpoint
N/A

### Parameters
- indexNames (String...) - The names of the indices to retrieve aliases for.

### Request Example
None

### Response
#### Success Response
- aliases (Map<String, ?>) - A map of index names to their aliases.
```

--------------------------------

### Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/support/querybyexample/QueryByExampleElasticsearchExecutor.html

Initializes a new instance of the QueryByExampleElasticsearchExecutor class.

```APIDOC
## QueryByExampleElasticsearchExecutor(ElasticsearchOperations operations)

### Description
Constructs a new QueryByExampleElasticsearchExecutor with the given Elasticsearch operations.

### Parameters
#### Path Parameters
- **operations** (ElasticsearchOperations) - The Elasticsearch operations instance to use.
```

--------------------------------

### getAliasesForIndex(String...) - IndexOperations

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

gets information about aliases

```APIDOC
## getAliasesForIndex(String...)

### Description
Gets information about aliases for the specified index names.

### Method
Method

### Endpoint
N/A

### Parameters
- indexNames (String...) - The names of the indices to retrieve aliases for.

### Request Example
None

### Response
#### Success Response
- aliases (Map<String, ?>) - A map of index names to their aliases.
```

--------------------------------

### ClientConfiguration

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchConfiguration.html

Must be implemented by deriving classes to provide the ClientConfiguration.

```APIDOC
## abstract ClientConfiguration clientConfiguration()

### Description
Must be implemented by deriving classes to provide the `ClientConfiguration`.

### Method
`abstract`
```

--------------------------------

### getAliasesFor(Class) - IndicesTemplate

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Get the `Alias` of the provided class.

```APIDOC
## getAliasesFor(Class)

### Description
Get the `Alias` of the provided class.

### Method
Method

### Endpoint
N/A

### Parameters
- clazz (Class<?>) - The class to get the alias for.

### Request Example
None

### Response
#### Success Response
- alias (Alias) - The Alias object for the provided class.
```

--------------------------------

### Completion Class Constructors

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/suggest/Completion.html

Provides details on how to instantiate the `Completion` class, allowing for the creation of completion suggestions with or without initial input.

```APIDOC
## Constructor Details

### Completion

```java
public Completion()
```

### Completion

```java
public Completion(String[] input)
```

### Completion

```java
public Completion(List<String> input)
```
```

--------------------------------

### getAliases(String...) - ReactiveIndexOperations

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

gets information about aliases

```APIDOC
## getAliases(String...)

### Description
Gets information about aliases for the specified index names asynchronously.

### Method
Method

### Endpoint
N/A

### Parameters
- indexNames (String...) - The names of the indices to retrieve aliases for.

### Request Example
None

### Response
#### Success Response
- aliases (Map<String, ?>) - A map of index names to their aliases.
```

--------------------------------

### ClientConfiguration Creation

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/class-use/ClientConfiguration.html

Methods for creating new ClientConfiguration instances.

```APIDOC
## ClientConfiguration.create(String hostAndPort)

### Description
Creates a new `ClientConfiguration` instance configured to a single host given `hostAndPort`.

### Method
`static ClientConfiguration`

### Parameters
#### Path Parameters
- **hostAndPort** (String) - Description of the host and port

### Return Value
- `ClientConfiguration` - A new instance of ClientConfiguration.
```

```APIDOC
## ClientConfiguration.create(InetSocketAddress socketAddress)

### Description
Creates a new `ClientConfiguration` instance configured to a single host given `InetSocketAddress`.

### Method
`static ClientConfiguration`

### Parameters
#### Path Parameters
- **socketAddress** (InetSocketAddress) - The socket address for the Elasticsearch host

### Return Value
- `ClientConfiguration` - A new instance of ClientConfiguration.
```

```APIDOC
## ClientConfiguration.localhost()

### Description
Creates a new `ClientConfiguration` instance configured to localhost.

### Method
`static ClientConfiguration`

### Return Value
- `ClientConfiguration` - A new instance of ClientConfiguration configured for localhost.
```

--------------------------------

### ElasticsearchNamespaceHandler init() Method

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/config/ElasticsearchNamespaceHandler.html

Initializes the namespace handler, registering parsers and decorators.

```APIDOC
## init()

### Description
Initializes the namespace handler. This method is called by the Spring container to register bean definition parsers and decorators specific to the Elasticsearch namespace.

### Method
`void init()`
```

--------------------------------

### getAliases(String...) - IndexOperations

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

gets information about aliases

```APIDOC
## getAliases(String...)

### Description
Gets information about aliases for the specified index names.

### Method
Method

### Endpoint
N/A

### Parameters
- indexNames (String...) - The names of the indices to retrieve aliases for.

### Request Example
None

### Response
#### Success Response
- aliases (Map<String, ?>) - A map of index names to their aliases.
```

--------------------------------

### Client Configuration

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClusterClient.html

Methods for configuring the client.

```APIDOC
## withTransportOptions

### Description
Configures the client with specific transport options.

### Method
`ReactiveElasticsearchClusterClient withTransportOptions(@Nullable TransportOptions transportOptions)`
```

--------------------------------

### Get Operations

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/mapping/class-use/IndexCoordinates.html

Retrieve documents by ID from specified indices.

```APIDOC
## get

### Description
Retrieves an object from the index specified in the entity's Document annotation.

### Method
`<T> @Nullable T`

### Signature
`DocumentOperations.get(String id, Class<T> clazz, IndexCoordinates index)`

---

## get

### Description
Fetch the entity with given id.

### Method
`<T> Mono<T>`

### Signature
`ReactiveDocumentOperations.get(String id, Class<T> entityType, IndexCoordinates index)`
```

--------------------------------

### Client Configuration

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html

Methods for configuring the client.

```APIDOC
## Client Configuration

### withTransportOptions

```java
public ReactiveElasticsearchClient withTransportOptions(@Nullable co.elastic.clients.transport.TransportOptions transportOptions)
```

Returns a new client with the given transport options applied. This method is specified by `co.elastic.clients.ApiClient`.
```

--------------------------------

### Get Script by Name

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/script/class-use/Script.html

Retrieves a script from Elasticsearch by its name.

```APIDOC
## GET Script by Name

### Description
Retrieves the script with the given name from Elasticsearch.

### Method
GET

### Endpoint
`/script/{name}` (This is a hypothetical endpoint based on common RESTful practices for script operations, the actual endpoint might differ based on the underlying Elasticsearch client implementation.)

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the script to retrieve.

### Response
#### Success Response (200)
- **Script** (object) - The retrieved script object.

#### Response Example
```json
{
  "script": "your_script_content",
  "lang": "your_script_language"
}
```
```

--------------------------------

### Request Size

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/Query.html

Get the number of documents requested for this query.

```APIDOC
## getRequestSize

### Description
Gets the number of documents that should be requested from Elasticsearch in this query. Depends whether a Pageable and/or maxResult size is set on the query.

### Method
Integer

### Returns
The number of documents that should be requested from Elasticsearch in this query.

### Since
5.1
```

--------------------------------

### Create Index with Settings and Mapping

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/IndicesTemplate.html

Creates an index with the specified settings and mapping. Returns true if the index was created successfully.

```APIDOC
## create

### Description
Create an index for given settings and mapping.

### Method
`boolean create(Map<String, Object> settings, Document mapping)`

### Parameters
#### Path Parameters
- `settings` (Map<String, Object>) - the index settings
- `mapping` (Document) - the index mapping

### Returns
true if the index was created
```

--------------------------------

### Indices Options

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/BaseQuery.html

Methods for getting the indices options for a search.

```APIDOC
## getIndicesOptions

### Description
Gets the indices options for the search.

### Method
`getIndicesOptions()`

### Returns
`@Nullable IndicesOptions` - The indices options, or null if not set.
```

--------------------------------

### Script Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/script/Script.html

Creates a new Script instance with the provided ID, language, and source code.

```APIDOC
## Script Constructor

### Description
Creates an instance of a `Script` record class.

### Parameters
* **id** (String) - The value for the `id` record component.
* **language** (String) - The value for the `language` record component.
* **source** (String) - The value for the `source` record component.
```

--------------------------------

### Search Type

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/BaseQuery.html

Methods for setting and getting the search type.

```APIDOC
## setSearchType

### Description
Sets the type of search to perform.

### Method
`setSearchType(@Nullable Query.SearchType searchType)`

### Parameters
- `searchType` (@Nullable Query.SearchType) - The type of search.

## getSearchType

### Description
Gets the type of search.

### Method
`getSearchType()`

### Returns
`@Nullable Query.SearchType` - The type of search, or null if not set.
```

--------------------------------

### BaseQueryBuilder Methods

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/class-use/Query.PointInTime.html

Illustrates how to configure Query.PointInTime using the BaseQueryBuilder.

```APIDOC
## BaseQueryBuilder

### Methods
- `SELF withPointInTime(@Nullable Query.PointInTime pointInTime)`
  - Description: Configures the query builder with a specific point in time.
```

--------------------------------

### ElasticsearchRepositoryConfigExtension Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/config/ElasticsearchRepositoryConfigExtension.html

Initializes a new instance of the ElasticsearchRepositoryConfigExtension class.

```APIDOC
## ElasticsearchRepositoryConfigExtension()

### Description
Initializes a new instance of the ElasticsearchRepositoryConfigExtension class.

### Constructor
`public ElasticsearchRepositoryConfigExtension()`
```

--------------------------------

### Retrieving HighlightFieldParameters

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/highlight/class-use/HighlightFieldParameters.html

Shows how to get HighlightFieldParameters from a Highlight object.

```APIDOC
## HighlightField.getParameters()

### Description
Retrieves the highlight field parameters associated with this highlight.

### Method
`getParameters()`

### Return Value
`HighlightFieldParameters` - The parameters for this highlight field.
```

--------------------------------

### getInformation (IndexCoordinates)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveIndexOperations.html

Gets the IndexInformation for the indices defined by getIndexCoordinates().

```APIDOC
## getInformation (IndexCoordinates)

### Description
Gets the `IndexInformation` for the indices defined by `getIndexCoordinates()`.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
- **index** (IndexCoordinates) - Required - The index coordinates.

### Returns
Flux<IndexInformation> - A flux of `IndexInformation`.

### Since
4.2
```

--------------------------------

### RepositorySearchTemplateQuery Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/repository/query/RepositorySearchTemplateQuery.html

Initializes a new instance of the RepositorySearchTemplateQuery class.

```APIDOC
## RepositorySearchTemplateQuery Constructor

### Description
Initializes a new instance of the `RepositorySearchTemplateQuery` class.

### Signature
`public RepositorySearchTemplateQuery(ElasticsearchQueryMethod queryMethod, ElasticsearchOperations elasticsearchOperations, ValueExpressionDelegate valueExpressionDelegate, String id)`

### Parameters
* `queryMethod` (ElasticsearchQueryMethod) - The query method.
* `elasticsearchOperations` (ElasticsearchOperations) - The Elasticsearch operations instance.
* `valueExpressionDelegate` (ValueExpressionDelegate) - The delegate for value expressions.
* `id` (String) - The ID of the search template.
```

--------------------------------

### String getEntityRouting(Object entity)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/ReactiveElasticsearchOperations.html

Gets the routing for an entity.

```APIDOC
## @Nullable String getEntityRouting(Object entity)

### Description
Gets the routing for an entity.

### Method
`getEntityRouting`
```

--------------------------------

### Create Index with Settings

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ReactiveIndicesTemplate.html

Creates an index with the specified settings. Returns a Mono signalling successful operation completion or an error if the index already exists.

```APIDOC
## create

### Description
Create an index with the specified settings.

### Method
```java
public Mono<Boolean> create(Map<String, @Nullable Object> settings)
```

### Parameters
#### Path Parameters
- **settings** (Map<String, @Nullable Object>) - index settings

### Returns
a `Mono` signalling successful operation completion or an `error` if eg. the index already exist.
```

--------------------------------

### Building a SearchFailure object

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/class-use/ByQueryResponse.SearchFailure.SearchFailureBuilder.html

Demonstrates how to create and configure a SearchFailure object using its builder pattern. This includes initializing the builder with a reason and setting various failure details.

```APIDOC
## Builder Methods for ByQueryResponse.SearchFailure.SearchFailureBuilder

### Description
Methods available on the `SearchFailureBuilder` to construct a `SearchFailure` object.

### Methods

- `static ByQueryResponse.SearchFailure.SearchFailureBuilder builder(Throwable reason)`
  - Creates a new `ByQueryResponse.SearchFailure.SearchFailureBuilder` initialized with the given `Throwable` reason.

- `ByQueryResponse.SearchFailure.SearchFailureBuilder withIndex(String index)`
  - Sets the index associated with the search failure.

- `ByQueryResponse.SearchFailure.SearchFailureBuilder withNodeId(String nodeId)`
  - Sets the node ID where the failure occurred.

- `ByQueryResponse.SearchFailure.SearchFailureBuilder withReason(Throwable reason)`
  - Sets or updates the `Throwable` reason for the search failure.

- `ByQueryResponse.SearchFailure.SearchFailureBuilder withShardId(Integer shardId)`
  - Sets the shard ID associated with the search failure.

- `ByQueryResponse.SearchFailure.SearchFailureBuilder withStatus(Integer status)`
  - Sets the HTTP status code associated with the search failure.
```

--------------------------------

### Get Rest5Client

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/class-use/ClientConfiguration.html

Creates a low-level Rest5Client for the given ClientConfiguration.

```APIDOC
## getRest5Client

### Description
Creates a low-level `Rest5Client` for the given configuration.

### Method
`static co.elastic.clients.transport.rest5_client.low_level.Rest5Client`

### Parameters
- `clientConfiguration` (ClientConfiguration) - The configuration for the client.
```

--------------------------------

### get(String name)

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchAggregations.html

Retrieves a specific aggregation by its name.

```APIDOC
## @Nullable ElasticsearchAggregation get(String name)

### Description
Returns the aggregation that is associated with the specified name.

### Parameters
#### Path Parameters
- **name** (String) - The name of the aggregation to retrieve.

### Returns
- `@Nullable ElasticsearchAggregation` - The aggregation object if found, otherwise null.
```

--------------------------------

### Create Index with Settings

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/client/elc/IndicesTemplate.html

Creates an index with the specified settings. Returns true if the index was created successfully.

```APIDOC
## create

### Description
Create an index for given settings.

### Method
`boolean create(Map<String, Object> settings)`

### Parameters
#### Path Parameters
- `settings` (Map<String, Object>) - the index settings

### Returns
true if the index was created
```

--------------------------------

### findBy Methods

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/index-all.html

Methods for finding entities based on an example and a function.

```APIDOC
## findBy(Example, Function)

### Description
Finds entities based on the provided example and applies a function to the results.

### Method
`findBy`

### Endpoint
N/A (Method Signature)

### Parameters
- **Example** (Example): The example object to query by.
- **Function** (Function): A function to apply to the query results.
```

--------------------------------

### IndicesOptions Creation Methods

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/class-use/IndicesOptions.html

Demonstrates static methods for creating custom IndicesOptions instances by specifying options and wildcard expansion states.

```APIDOC
## Creating IndicesOptions

### Description
These static factory methods allow you to create `IndicesOptions` instances with specific configurations.

### Methods
- `static IndicesOptions of(EnumSet<IndicesOptions.Option> options, EnumSet<IndicesOptions.WildcardStates> expandWildcards)`
  Creates `IndicesOptions` with specified options and wildcard expansion states.
- `static IndicesOptions oFExpandWildcards(EnumSet<IndicesOptions.WildcardStates> expandWildcards)`
  Creates `IndicesOptions` primarily configured by wildcard expansion states.
- `static IndicesOptions ofOptions(EnumSet<IndicesOptions.Option> options)`
  Creates `IndicesOptions` with specified options.
```

--------------------------------

### MoreLikeThisQuery Constructor

Source: https://docs.spring.io/spring-data/elasticsearch/docs/current/api/org/springframework/data/elasticsearch/core/query/MoreLikeThisQuery.html

Initializes a new instance of the MoreLikeThisQuery class.

```APIDOC
## MoreLikeThisQuery()

### Description

Creates a new MoreLikeThisQuery instance with default settings.

### Constructor

`MoreLikeThisQuery()`
```
Tokens:
Raw