org.apache.nifi.elasticsearch

Interface ElasticSearchClientService

All Superinterfaces:

ConfigurableComponent, ControllerService

@Tags(value={"elasticsearch","client"})
 @CapabilityDescription(value="A controller service for accessing an ElasticSearch client.")
public interface ElasticSearchClientService
extends ControllerService

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CHARSET
static PropertyDescriptor	CONNECT_TIMEOUT
static PropertyDescriptor	HTTP_HOSTS
static PropertyDescriptor	PASSWORD
static PropertyDescriptor	PROP_SSL_CONTEXT_SERVICE
static PropertyDescriptor	RETRY_TIMEOUT
static PropertyDescriptor	SOCKET_TIMEOUT
static PropertyDescriptor	USERNAME

Method Summary

Modifier and Type	Method and Description
String	getTransitUrl(String index, String type) Build a transit URL to use with the provenance reporter.
SearchResponse	search(String query, String index, String type) Perform a search using the JSON DSL.

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

HTTP_HOSTS

static final PropertyDescriptor HTTP_HOSTS

PROP_SSL_CONTEXT_SERVICE

static final PropertyDescriptor PROP_SSL_CONTEXT_SERVICE

USERNAME

static final PropertyDescriptor USERNAME

PASSWORD

static final PropertyDescriptor PASSWORD

CONNECT_TIMEOUT

static final PropertyDescriptor CONNECT_TIMEOUT

SOCKET_TIMEOUT

static final PropertyDescriptor SOCKET_TIMEOUT

RETRY_TIMEOUT

static final PropertyDescriptor RETRY_TIMEOUT

CHARSET

static final PropertyDescriptor CHARSET

Method Detail

search

SearchResponse search(String query,
                      String index,
                      String type)
               throws IOException

Perform a search using the JSON DSL.

Parameters:

query - A JSON string reprensenting the query.

index - The index to target. Optional.

type - The type to target. Optional. Will not be used in future versions of ElasticSearch.

Returns:

A SearchResponse object if successful.

Throws:

IOException

getTransitUrl

String getTransitUrl(String index,
                     String type)

Build a transit URL to use with the provenance reporter.

Parameters:

index - Index targeted. Optional.

type - Type targeted. Optional

Returns:

a URL describing the ElasticSearch cluster.