org.apache.nifi.elasticsearch

Interface ElasticSearchClientService

All Superinterfaces:

ConfigurableComponent, ControllerService, VerifiableControllerService

public interface ElasticSearchClientService
extends ControllerService, VerifiableControllerService

Field Summary

Fields

Modifier and Type	Field and Description
static AllowableValue	ALWAYS_SUPPRESS
static PropertyDescriptor	API_KEY
static PropertyDescriptor	API_KEY_ID
static PropertyDescriptor	AUTHORIZATION_SCHEME
static PropertyDescriptor	CHARSET
static PropertyDescriptor	COMPRESSION
static PropertyDescriptor	CONNECT_TIMEOUT
static PropertyDescriptor	HTTP_HOSTS
static AllowableValue	NEVER_SUPPRESS
static PropertyDescriptor	NODE_SELECTOR
static AllowableValue	NODE_SELECTOR_ANY
static AllowableValue	NODE_SELECTOR_SKIP_DEDICATED_MASTERS
static PropertyDescriptor	PASSWORD
static PropertyDescriptor	PATH_PREFIX
static PropertyDescriptor	PROP_SSL_CONTEXT_SERVICE
static PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
static PropertyDescriptor	RETRY_TIMEOUT Deprecated. this setting is no longer used and will be removed in a future version. Property retained for now to prevent existing Flows with this processor from breaking upon upgrade.
static PropertyDescriptor	SEND_META_HEADER
static PropertyDescriptor	SNIFF_CLUSTER_NODES
static PropertyDescriptor	SNIFF_ON_FAILURE
static PropertyDescriptor	SNIFFER_FAILURE_DELAY
static PropertyDescriptor	SNIFFER_INTERVAL
static PropertyDescriptor	SNIFFER_REQUEST_TIMEOUT
static PropertyDescriptor	SOCKET_TIMEOUT
static PropertyDescriptor	STRICT_DEPRECATION
static PropertyDescriptor	SUPPRESS_NULLS
static PropertyDescriptor	USERNAME

Method Summary

Modifier and Type	Method and Description
IndexOperationResponse	add(IndexOperationRequest operation, Map<String,String> requestParameters) Index a document.
IndexOperationResponse	bulk(List<IndexOperationRequest> operations, Map<String,String> requestParameters) Bulk process multiple documents.
Long	count(String query, String index, String type, Map<String,String> requestParameters) Count the documents that match the criteria.
DeleteOperationResponse	deleteById(String index, String type, List<String> ids, Map<String,String> requestParameters) Delete multiple documents by ID from an index.
DeleteOperationResponse	deleteById(String index, String type, String id, Map<String,String> requestParameters) Delete a document by its ID from an index.
DeleteOperationResponse	deleteByQuery(String query, String index, String type, Map<String,String> requestParameters) Delete documents by query.
DeleteOperationResponse	deletePointInTime(String pitId) Delete a Point in Time.
DeleteOperationResponse	deleteScroll(String scrollId) Delete a Scroll.
boolean	documentExists(String index, String type, String id, Map<String,String> requestParameters) Check whether a document exists.
boolean	exists(String index, Map<String,String> requestParameters) Check whether an index exists.
Map<String,Object>	get(String index, String type, String id, Map<String,String> requestParameters) Get a document by ID.
String	getTransitUrl(String index, String type) Build a transit URL to use with the provenance reporter.
String	initialisePointInTime(String index, String keepAlive) Initialise a Point in Time for paginated queries.
void	refresh(String index, Map<String,String> requestParameters) Refresh index/indices.
SearchResponse	scroll(String scroll) Retrieve next page of results from a Scroll.
SearchResponse	search(String query, String index, String type, Map<String,String> requestParameters) Perform a search using the JSON DSL.
UpdateOperationResponse	updateByQuery(String query, String index, String type, Map<String,String> requestParameters) Update documents by query.

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

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

verify

Field Detail

HTTP_HOSTS

static final PropertyDescriptor HTTP_HOSTS

PROP_SSL_CONTEXT_SERVICE

static final PropertyDescriptor PROP_SSL_CONTEXT_SERVICE

PROXY_CONFIGURATION_SERVICE

static final PropertyDescriptor PROXY_CONFIGURATION_SERVICE

AUTHORIZATION_SCHEME

static final PropertyDescriptor AUTHORIZATION_SCHEME

USERNAME

static final PropertyDescriptor USERNAME

PASSWORD

static final PropertyDescriptor PASSWORD

API_KEY_ID

static final PropertyDescriptor API_KEY_ID

API_KEY

static final PropertyDescriptor API_KEY

CONNECT_TIMEOUT

static final PropertyDescriptor CONNECT_TIMEOUT

SOCKET_TIMEOUT

static final PropertyDescriptor SOCKET_TIMEOUT

RETRY_TIMEOUT

@Deprecated
static final PropertyDescriptor RETRY_TIMEOUT

Deprecated. this setting is no longer used and will be removed in a future version. Property retained for now to prevent existing Flows with this processor from breaking upon upgrade.

CHARSET

static final PropertyDescriptor CHARSET

ALWAYS_SUPPRESS

static final AllowableValue ALWAYS_SUPPRESS

NEVER_SUPPRESS

static final AllowableValue NEVER_SUPPRESS

SUPPRESS_NULLS

static final PropertyDescriptor SUPPRESS_NULLS

COMPRESSION

static final PropertyDescriptor COMPRESSION

SEND_META_HEADER

static final PropertyDescriptor SEND_META_HEADER

STRICT_DEPRECATION

static final PropertyDescriptor STRICT_DEPRECATION

NODE_SELECTOR_ANY

static final AllowableValue NODE_SELECTOR_ANY

NODE_SELECTOR_SKIP_DEDICATED_MASTERS

static final AllowableValue NODE_SELECTOR_SKIP_DEDICATED_MASTERS

NODE_SELECTOR

static final PropertyDescriptor NODE_SELECTOR

PATH_PREFIX

static final PropertyDescriptor PATH_PREFIX

SNIFF_CLUSTER_NODES

static final PropertyDescriptor SNIFF_CLUSTER_NODES

SNIFF_ON_FAILURE

static final PropertyDescriptor SNIFF_ON_FAILURE

SNIFFER_INTERVAL

static final PropertyDescriptor SNIFFER_INTERVAL

SNIFFER_REQUEST_TIMEOUT

static final PropertyDescriptor SNIFFER_REQUEST_TIMEOUT

SNIFFER_FAILURE_DELAY

static final PropertyDescriptor SNIFFER_FAILURE_DELAY

Method Detail

add

IndexOperationResponse add(IndexOperationRequest operation,
                           Map<String,String> requestParameters)

Index a document.

Parameters:

operation - A document to index.

requestParameters - A collection of URL request parameters. Optional.

Returns:

IndexOperationResponse if successful

bulk

IndexOperationResponse bulk(List<IndexOperationRequest> operations,
                            Map<String,String> requestParameters)

Bulk process multiple documents.

Parameters:

operations - A list of index operations.

requestParameters - A collection of URL request parameters. Optional.

Returns:

IndexOperationResponse if successful.

count

Long count(String query,
           String index,
           String type,
           Map<String,String> requestParameters)

Count the documents that match the criteria.

Parameters:

query - A query in the JSON DSL syntax

index - The index to target.

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

requestParameters - A collection of URL request parameters. Optional.

Returns:

number of documents matching the query

deleteById

DeleteOperationResponse deleteById(String index,
                                   String type,
                                   String id,
                                   Map<String,String> requestParameters)

Delete a document by its ID from an index.

Parameters:

index - The index to target.

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

id - The document ID to remove from the selected index.

requestParameters - A collection of URL request parameters. Optional.

Returns:

A DeleteOperationResponse object if successful.

deleteById

DeleteOperationResponse deleteById(String index,
                                   String type,
                                   List<String> ids,
                                   Map<String,String> requestParameters)

Delete multiple documents by ID from an index.

Parameters:

index - The index to target.

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

ids - A list of document IDs to remove from the selected index.

requestParameters - A collection of URL request parameters. Optional.

Returns:

A DeleteOperationResponse object if successful.

deleteByQuery

DeleteOperationResponse deleteByQuery(String query,
                                      String index,
                                      String type,
                                      Map<String,String> requestParameters)

Delete documents by query.

Parameters:

query - A valid JSON query to be used for finding documents to delete.

index - The index to target.

type - The type to target within the index. Optional. Will not be used in future versions of Elasticsearch.

requestParameters - A collection of URL request parameters. Optional.

Returns:

A DeleteOperationResponse object if successful.

updateByQuery

UpdateOperationResponse updateByQuery(String query,
                                      String index,
                                      String type,
                                      Map<String,String> requestParameters)

Update documents by query.

Parameters:

query - A valid JSON query to be used for finding documents to update.

index - The index to target.

type - The type to target within the index. Optional. Will not be used in future versions of Elasticsearch.

requestParameters - A collection of URL request parameters. Optional.

Returns:

An UpdateOperationResponse object if successful.

refresh

void refresh(String index,
             Map<String,String> requestParameters)

Refresh index/indices.

Parameters:

index - The index to target, if omitted then all indices will be updated.

requestParameters - A collection of URL request parameters. Optional.

exists

boolean exists(String index,
               Map<String,String> requestParameters)

Check whether an index exists.

Parameters:

index - The index to check.

requestParameters - A collection of URL request parameters. Optional.

documentExists

boolean documentExists(String index,
                       String type,
                       String id,
                       Map<String,String> requestParameters)

Check whether a document exists.

Parameters:

index - The index that holds the document.

type - The document type. Optional. Will not be used in future versions of Elasticsearch.

id - The document ID

requestParameters - A collection of URL request parameters. Optional.

get

Map<String,Object> get(String index,
                       String type,
                       String id,
                       Map<String,String> requestParameters)

Get a document by ID.

Parameters:

index - The index that holds the document.

type - The document type. Optional. Will not be used in future versions of Elasticsearch.

id - The document ID

requestParameters - A collection of URL request parameters. Optional.

Returns:

Map if successful, null if not found.

search

SearchResponse search(String query,
                      String index,
                      String type,
                      Map<String,String> requestParameters)

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.

requestParameters - A collection of URL request parameters. Optional.

Returns:

A SearchResponse object if successful.

scroll

SearchResponse scroll(String scroll)

Retrieve next page of results from a Scroll.

Parameters:

scroll - A JSON string containing scrollId and optional scroll (keep alive) retention period.

Returns:

A SearchResponse object if successful.

initialisePointInTime

String initialisePointInTime(String index,
                             String keepAlive)

Initialise a Point in Time for paginated queries. Requires Elasticsearch 7.10+ and XPack features.

Parameters:

index - Index targeted.

keepAlive - Point in Time's retention period (maximum time Elasticsearch will retain the PiT between requests). Optional.

Returns:

the Point in Time Id (pit_id)

deletePointInTime

DeleteOperationResponse deletePointInTime(String pitId)

Delete a Point in Time. Requires Elasticsearch 7.10+ and XPack features.

Parameters:

pitId - Point in Time Id to be deleted.

Returns:

A DeleteOperationResponse object if successful.

deleteScroll

DeleteOperationResponse deleteScroll(String scrollId)

Delete a Scroll.

Parameters:

scrollId - Scroll Id to be deleted.

Returns:

A DeleteOperationResponse object if successful.

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.