org.springframework.data.elasticsearch.client.elc

Class ReactiveIndicesTemplate

java.lang.Object

org.springframework.data.elasticsearch.client.elc.ReactiveChildTemplate<ReactiveElasticsearchIndicesClient>

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

All Implemented Interfaces:

ReactiveIndexOperations

public class ReactiveIndicesTemplate
extends ReactiveChildTemplate<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 org.reactivestreams.Publisher<?>>

Field Summary

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

client, elasticsearchConverter, exceptionTranslator, requestConverter, responseConverter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Boolean>	alias(AliasActions aliasActions) Executes the given AliasActions.
reactor.core.publisher.Mono<Boolean>	create() Create an index.
reactor.core.publisher.Mono<Boolean>	create(Map<String,Object> settings) Create an index with the specified settings.
reactor.core.publisher.Mono<Boolean>	create(Map<String,Object> settings, Document mapping) Create an index for given settings and mapping.
reactor.core.publisher.Mono<Document>	createMapping() Creates the index mapping for the entity this IndexOperations is bound to.
reactor.core.publisher.Mono<Document>	createMapping(Class<?> clazz) Creates the index mapping for the given class
reactor.core.publisher.Mono<Settings>	createSettings() Creates the index settings for the entity this IndexOperations is bound to.
reactor.core.publisher.Mono<Settings>	createSettings(Class<?> clazz) Creates the index settings from the annotations on the given class
reactor.core.publisher.Mono<Boolean>	createWithMapping() Create an index with the settings and mapping defined for the entity this IndexOperations is bound to.
reactor.core.publisher.Mono<Boolean>	delete() Delete an index.
reactor.core.publisher.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)
reactor.core.publisher.Mono<Boolean>	exists() checks if an index exists
reactor.core.publisher.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)
reactor.core.publisher.Mono<Map<String,Set<AliasData>>>	getAliases(String... aliasNames) gets information about aliases
reactor.core.publisher.Mono<Map<String,Set<AliasData>>>	getAliasesForIndex(String... indexNames) gets information about aliases
IndexCoordinates	getIndexCoordinates() get the current IndexCoordinates.
reactor.core.publisher.Flux<IndexInformation>	getInformation(IndexCoordinates index) Gets the IndexInformation for the indices defined by ReactiveIndexOperations.getIndexCoordinates().
reactor.core.publisher.Mono<Document>	getMapping() Get mapping for the index targeted defined by this ReactiveIndexOperations
reactor.core.publisher.Mono<Settings>	getSettings(boolean includeDefaults) get the settings for the index
reactor.core.publisher.Mono<TemplateData>	getTemplate(GetTemplateRequest getTemplateRequest) gets an index template using the legacy Elasticsearch interface.
reactor.core.publisher.Mono<Boolean>	putMapping(reactor.core.publisher.Mono<Document> mapping) writes a mapping to the index
reactor.core.publisher.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)
reactor.core.publisher.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

deleteTemplate, existsTemplate, getInformation, getSettings, getTemplate, putMapping, putMapping

Constructor Detail

ReactiveIndicesTemplate

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

ReactiveIndicesTemplate

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

Method Detail

create

public reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.Mono<Boolean> putMapping(reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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

getTemplate

public reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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