Package org.springframework.data.elasticsearch.client.elc

Class ReactiveIndicesTemplate

java.lang.Object

org.springframework.data.elasticsearch.client.elc.ReactiveChildTemplate<co.elastic.clients.transport.ElasticsearchTransport,ReactiveElasticsearchIndicesClient>

org.springframework.data.elasticsearch.client.elc.ReactiveIndicesTemplate

All Implemented Interfaces:

ReactiveIndexOperations

public class ReactiveIndicesTemplate
extends ReactiveChildTemplate<co.elastic.clients.transport.ElasticsearchTransport,ReactiveElasticsearchIndicesClient>
implements ReactiveIndexOperations

Author:

Peter-Josef Meisch

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.elasticsearch.client.elc.ReactiveChildTemplate

ReactiveChildTemplate.ClientCallback<CLIENT,RESULT extends Publisher<?>>

Field Summary

Fields inherited from class org.springframework.data.elasticsearch.client.elc.ReactiveChildTemplate

client, elasticsearchConverter, exceptionTranslator, requestConverter, responseConverter

Constructor Summary

Constructors

Constructor	Description
ReactiveIndicesTemplate(ReactiveElasticsearchIndicesClient client, ReactiveClusterTemplate clusterTemplate, ElasticsearchConverter elasticsearchConverter, Class<?> clazz)
ReactiveIndicesTemplate(ReactiveElasticsearchIndicesClient client, ReactiveClusterTemplate clusterTemplate, ElasticsearchConverter elasticsearchConverter, IndexCoordinates index)

Method Summary

Modifier and Type	Method	Description
Mono<Boolean>	alias(AliasActions aliasActions)	Executes the given AliasActions.
Mono<Boolean>	create()	Create an index.
Mono<Boolean>	create(Map<String,Object> settings)	Create an index with the specified settings.
Mono<Boolean>	create(Map<String,Object> settings, Document mapping)	Create an index for given settings and mapping.
Mono<Document>	createMapping()	Creates the index mapping for the entity this IndexOperations is bound to.
Mono<Document>	createMapping(Class<?> clazz)	Creates the index mapping for the given class
Mono<Settings>	createSettings()	Creates the index settings for the entity this IndexOperations is bound to.
Mono<Settings>	createSettings(Class<?> clazz)	Creates the index settings from the annotations on the given class
Mono<Boolean>	createWithMapping()	Create an index with the settings and mapping defined for the entity this IndexOperations is bound to.
Mono<Boolean>	delete()	Delete an index.
Mono<Boolean>	deleteComponentTemplate(DeleteComponentTemplateRequest deleteComponentTemplateRequest)	Deletes a component index template.
Mono<Boolean>	deleteIndexTemplate(DeleteIndexTemplateRequest deleteIndexTemplateRequest)	Deletes an index template.
Mono<Boolean>	deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)	Deletes an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
Mono<Boolean>	exists()	checks if an index exists
Mono<Boolean>	existsComponentTemplate(ExistsComponentTemplateRequest existsComponentTemplateRequest)	Checks wether a component index template exists.
Mono<Boolean>	existsIndexTemplate(ExistsIndexTemplateRequest existsIndexTemplateRequest)	Checks if an index template exists.
Mono<Boolean>	existsTemplate(ExistsTemplateRequest existsTemplateRequest)	Checks if an index template exists using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
Mono<Map<String,Set<AliasData>>>	getAliases(String... aliasNames)	gets information about aliases
Mono<Map<String,Set<AliasData>>>	getAliasesForIndex(String... indexNames)	gets information about aliases
Flux<TemplateResponse>	getComponentTemplate(GetComponentTemplateRequest getComponentTemplateRequest)	Get component template(s).
IndexCoordinates	getIndexCoordinates()	get the current IndexCoordinates.
Flux<TemplateResponse>	getIndexTemplate(GetIndexTemplateRequest getIndexTemplateRequest)	Get index template(s).
Flux<IndexInformation>	getInformation(IndexCoordinates index)	Gets the IndexInformation for the indices defined by ReactiveIndexOperations.getIndexCoordinates().
Mono<Document>	getMapping()	Get mapping for the index targeted defined by this ReactiveIndexOperations
Mono<Settings>	getSettings(boolean includeDefaults)	get the settings for the index
Mono<TemplateData>	getTemplate(GetTemplateRequest getTemplateRequest)	gets an index template using the legacy Elasticsearch interface.
Mono<Boolean>	putComponentTemplate(PutComponentTemplateRequest putComponentTemplateRequest)	Writes a component index template that can be used in a composable index template.
Mono<Boolean>	putIndexTemplate(PutIndexTemplateRequest putIndexTemplateRequest)	Creates an index template.
Mono<Boolean>	putMapping(Mono<Document> mapping)	writes a mapping to the index
Mono<Boolean>	putTemplate(PutTemplateRequest putTemplateRequest)	Creates an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
Mono<Void>	refresh()	Refresh the index(es) this IndexOperations is bound to

Methods inherited from class org.springframework.data.elasticsearch.client.elc.ReactiveChildTemplate

execute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.elasticsearch.core.ReactiveIndexOperations

deleteIndexTemplate, deleteTemplate, existsIndexTemplate, existsTemplate, getIndexTemplate, getInformation, getSettings, getTemplate, putMapping, putMapping

Constructor Details

ReactiveIndicesTemplate

public ReactiveIndicesTemplate(ReactiveElasticsearchIndicesClient client,
 ReactiveClusterTemplate clusterTemplate,
 ElasticsearchConverter elasticsearchConverter,
 IndexCoordinates index)

ReactiveIndicesTemplate

public ReactiveIndicesTemplate(ReactiveElasticsearchIndicesClient client,
 ReactiveClusterTemplate clusterTemplate,
 ElasticsearchConverter elasticsearchConverter,
 Class<?> clazz)

Method Details

create

public Mono<Boolean> create()

Description copied from interface: ReactiveIndexOperations

Create an index.

Specified by:

create in interface ReactiveIndexOperations

Returns:

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

create

public Mono<Boolean> create(Map<String,Object> settings)

Description copied from interface: ReactiveIndexOperations

Create an index with the specified settings.

Specified by:

create in interface ReactiveIndexOperations

Parameters:

settings - index settings

Returns:

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

create

public Mono<Boolean> create(Map<String,Object> settings,
 Document mapping)

Description copied from interface: ReactiveIndexOperations

Create an index for given settings and mapping.

Specified by:

create in interface ReactiveIndexOperations

Parameters:

settings - the index settings

mapping - the index mapping

Returns:

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

createWithMapping

public Mono<Boolean> createWithMapping()

Description copied from interface: ReactiveIndexOperations

Create an index with the settings and mapping defined for the entity this IndexOperations is bound to.

Specified by:

createWithMapping in interface ReactiveIndexOperations

Returns:

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

delete

public Mono<Boolean> delete()

Description copied from interface: ReactiveIndexOperations

Delete an index.

Specified by:

delete in interface ReactiveIndexOperations

Returns:

a Mono signalling operation completion or an error. If the index does not exist, a value of false is emitted.

exists

public Mono<Boolean> exists()

Description copied from interface: ReactiveIndexOperations

checks if an index exists

Specified by:

exists in interface ReactiveIndexOperations

Returns:

a Mono with the result of exist check

refresh

public Mono<Void> refresh()

Description copied from interface: ReactiveIndexOperations

Refresh the index(es) this IndexOperations is bound to

Specified by:

refresh in interface ReactiveIndexOperations

Returns:

a Mono signalling operation completion.

createMapping

public Mono<Document> createMapping()

Description copied from interface: ReactiveIndexOperations

Creates the index mapping for the entity this IndexOperations is bound to.

Specified by:

createMapping in interface ReactiveIndexOperations

Returns:

mapping object

createMapping

public Mono<Document> createMapping(Class<?> clazz)

Description copied from interface: ReactiveIndexOperations

Creates the index mapping for the given class

Specified by:

createMapping in interface ReactiveIndexOperations

Parameters:

clazz - the clazz to create a mapping for

Returns:

a Mono with the mapping document

putMapping

public Mono<Boolean> putMapping(Mono<Document> mapping)

Description copied from interface: ReactiveIndexOperations

writes a mapping to the index

Specified by:

putMapping in interface ReactiveIndexOperations

Parameters:

mapping - the Document with the mapping definitions

Returns:

true if the mapping could be stored

getMapping

public Mono<Document> getMapping()

Description copied from interface: ReactiveIndexOperations

Get mapping for the index targeted defined by this ReactiveIndexOperations

Specified by:

getMapping in interface ReactiveIndexOperations

Returns:

the mapping

createSettings

public Mono<Settings> createSettings()

Description copied from interface: ReactiveIndexOperations

Creates the index settings for the entity this IndexOperations is bound to.

Specified by:

createSettings in interface ReactiveIndexOperations

Returns:

a settings document.

createSettings

public Mono<Settings> createSettings(Class<?> clazz)

Description copied from interface: ReactiveIndexOperations

Creates the index settings from the annotations on the given class

Specified by:

createSettings in interface ReactiveIndexOperations

Parameters:

clazz - the class to create the index settings from

Returns:

a settings document.

getSettings

public Mono<Settings> getSettings(boolean includeDefaults)

Description copied from interface: ReactiveIndexOperations

get the settings for the index

Specified by:

getSettings in interface ReactiveIndexOperations

Parameters:

includeDefaults - whether or not to include all the default settings

Returns:

a Mono with a Document containing the index settings

alias

public Mono<Boolean> alias(AliasActions aliasActions)

Description copied from interface: ReactiveIndexOperations

Executes the given AliasActions.

Specified by:

alias in interface ReactiveIndexOperations

Parameters:

aliasActions - the actions to execute

Returns:

if the operation is acknowledged by Elasticsearch

getAliases

public Mono<Map<String,Set<AliasData>>> getAliases(String... aliasNames)

Description copied from interface: ReactiveIndexOperations

gets information about aliases

Specified by:

getAliases in interface ReactiveIndexOperations

Parameters:

aliasNames - alias names, must not be null

Returns:

a Mono of Map from index names to AliasData for that index

getAliasesForIndex

public Mono<Map<String,Set<AliasData>>> getAliasesForIndex(String... indexNames)

Description copied from interface: ReactiveIndexOperations

gets information about aliases

Specified by:

getAliasesForIndex in interface ReactiveIndexOperations

Parameters:

indexNames - alias names, must not be null

Returns:

a Mono of Map from index names to AliasData for that index

putTemplate

public Mono<Boolean> putTemplate(PutTemplateRequest putTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Creates an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)

Specified by:

putTemplate in interface ReactiveIndexOperations

Parameters:

putTemplateRequest - template request parameters

Returns:

Mono of true if the template could be stored

putComponentTemplate

public Mono<Boolean> putComponentTemplate(PutComponentTemplateRequest putComponentTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Writes a component index template that can be used in a composable index template.

Specified by:

putComponentTemplate in interface ReactiveIndexOperations

Parameters:

putComponentTemplateRequest - index template request parameters

Returns:

true if successful

getComponentTemplate

public Flux<TemplateResponse> getComponentTemplate(GetComponentTemplateRequest getComponentTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Get component template(s).

Specified by:

getComponentTemplate in interface ReactiveIndexOperations

Parameters:

getComponentTemplateRequest - the getComponentTemplateRequest parameters

Returns:

a Flux of TemplateResponse

existsComponentTemplate

public Mono<Boolean> existsComponentTemplate(ExistsComponentTemplateRequest existsComponentTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Checks wether a component index template exists.

Specified by:

existsComponentTemplate in interface ReactiveIndexOperations

Parameters:

existsComponentTemplateRequest - the parameters for the request

Returns:

Mono with the value if the componentTemplate exists.

deleteComponentTemplate

public Mono<Boolean> deleteComponentTemplate(DeleteComponentTemplateRequest deleteComponentTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Deletes a component index template.

Specified by:

deleteComponentTemplate in interface ReactiveIndexOperations

Parameters:

deleteComponentTemplateRequest - the parameters for the request

Returns:

Mono with the value if the request was acknowledged.

putIndexTemplate

public Mono<Boolean> putIndexTemplate(PutIndexTemplateRequest putIndexTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Creates an index template.

Specified by:

putIndexTemplate in interface ReactiveIndexOperations

Parameters:

putIndexTemplateRequest - template request parameters

Returns:

true if successful

existsIndexTemplate

public Mono<Boolean> existsIndexTemplate(ExistsIndexTemplateRequest existsIndexTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Checks if an index template exists.

Specified by:

existsIndexTemplate in interface ReactiveIndexOperations

Parameters:

existsIndexTemplateRequest - the parameters for the request

Returns:

Mono with the value if the index template exists.

getIndexTemplate

public Flux<TemplateResponse> getIndexTemplate(GetIndexTemplateRequest getIndexTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Get index template(s).

Specified by:

getIndexTemplate in interface ReactiveIndexOperations

Returns:

a Flux of TemplateResponse

deleteIndexTemplate

public Mono<Boolean> deleteIndexTemplate(DeleteIndexTemplateRequest deleteIndexTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Deletes an index template.

Specified by:

deleteIndexTemplate in interface ReactiveIndexOperations

Parameters:

deleteIndexTemplateRequest - the parameters for the request

Returns:

Mono with the value if the request was acknowledged.

getTemplate

public Mono<TemplateData> getTemplate(GetTemplateRequest getTemplateRequest)

Description copied from interface: ReactiveIndexOperations

gets an index template using the legacy Elasticsearch interface.

Specified by:

getTemplate in interface ReactiveIndexOperations

Parameters:

getTemplateRequest - the request parameters

Returns:

Mono of TemplateData, Mono.empty() if no template with the given name exists.

existsTemplate

public Mono<Boolean> existsTemplate(ExistsTemplateRequest existsTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Checks if an index template exists using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)

Specified by:

existsTemplate in interface ReactiveIndexOperations

Parameters:

existsTemplateRequest - template request parameters

Returns:

Mono of true if the template exists

deleteTemplate

public Mono<Boolean> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)

Description copied from interface: ReactiveIndexOperations

Deletes an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)

Specified by:

deleteTemplate in interface ReactiveIndexOperations

Parameters:

deleteTemplateRequest - template request parameters

Returns:

Mono of true if the template could be deleted

getInformation

public Flux<IndexInformation> getInformation(IndexCoordinates index)

Description copied from interface: ReactiveIndexOperations

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

Specified by:

getInformation in interface ReactiveIndexOperations

Returns:

a flux of IndexInformation

getIndexCoordinates

public IndexCoordinates getIndexCoordinates()

Description copied from interface: ReactiveIndexOperations

get the current IndexCoordinates. These may change over time when the entity class has a SpEL constructed index name. When this IndexOperations is not bound to a class, the bound IndexCoordinates are returned.

Specified by:

getIndexCoordinates in interface ReactiveIndexOperations

Returns:

IndexCoordinates