org.apache.beam.it.elasticsearch

Class ElasticsearchResourceManager

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager<GenericContainer<?>>

org.apache.beam.it.elasticsearch.ElasticsearchResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public class ElasticsearchResourceManager
extends TestContainerResourceManager<GenericContainer<?>>
implements org.apache.beam.it.common.ResourceManager

Client for managing Elasticsearch resources.

The class supports many indices per resource manager object.

The index name is formed using testId. The index name will be "{prefix}-{testId}-{ISO8601 time, microsecond precision}".

The class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElasticsearchResourceManager.Builder Builder for ElasticsearchResourceManager.

Field Summary

Fields inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

HOST_IP, port

Method Summary

Modifier and Type	Method and Description
static ElasticsearchResourceManager.Builder	builder(java.lang.String testId)
void	cleanupAll() Deletes all created resources and cleans up the Elasticsearch client, making the manager object unusable.
long	count(java.lang.String indexName) Gets the count of documents in an index.
boolean	createIndex(java.lang.String indexName) Creates an index on Elasticsearch.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	fetchAll(java.lang.String indexName) Reads all the documents in an index.
java.lang.String	getUri() Returns the URI connection string to the Elasticsearch service.
boolean	insertDocuments(java.lang.String indexName, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> documents) Inserts the given Documents into a collection.

Methods inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

getDockerImageName, getHost, getPort

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ElasticsearchResourceManager.Builder builder(java.lang.String testId)

getUri

public java.lang.String getUri()

Returns the URI connection string to the Elasticsearch service.

createIndex

public boolean createIndex(java.lang.String indexName)
                    throws ElasticsearchResourceManagerException

Creates an index on Elasticsearch.

Parameters:

indexName - Name of the index to create.

Returns:

A boolean indicating whether the resource was created.

Throws:

ElasticsearchResourceManagerException - if there is an error creating the collection in Elasticsearch.

insertDocuments

public boolean insertDocuments(java.lang.String indexName,
                               java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> documents)
                        throws ElasticsearchResourceManagerException

Inserts the given Documents into a collection.

Note: Implementations may do collection creation here, if one does not already exist.

Parameters:

indexName - The name of the index to insert the documents into.

documents - A map of (id, document) to insert into the collection.

Returns:

A boolean indicating whether the Documents were inserted successfully.

Throws:

ElasticsearchResourceManagerException - if there is an error inserting the documents.

fetchAll

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> fetchAll(java.lang.String indexName)
                                                                          throws ElasticsearchResourceManagerException

Reads all the documents in an index.

Parameters:

indexName - The name of the index to read from.

Returns:

An iterable of all the Documents in the collection.

Throws:

ElasticsearchResourceManagerException - if there is an error reading the data.

count

public long count(java.lang.String indexName)
           throws ElasticsearchResourceManagerException

Gets the count of documents in an index.

Parameters:

indexName - The name of the index to read from.

Returns:

The number of documents for the given index

Throws:

ElasticsearchResourceManagerException - if there is an error reading the data.

cleanupAll

public void cleanupAll()
                throws ElasticsearchResourceManagerException

Deletes all created resources and cleans up the Elasticsearch client, making the manager object unusable.

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager

Overrides:

cleanupAll in class TestContainerResourceManager<GenericContainer<?>>

Throws:

ElasticsearchResourceManagerException - if there is an error deleting the Elasticsearch resources.