ElasticSearchDataProvider::ElasticSearchRestConnection Class Reference

ElasticSearch REST connection. More...

#include <ElasticSearchRestConnection.qc.dox.h>

Inheritance diagram for ElasticSearchDataProvider::ElasticSearchRestConnection:

Public Member Functions
	constructor (hash< auto > config, *hash< auto > attr)
	creates the ElasticSearchRestConnection object
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the ElasticSearchRestConnection object
DataProvider::AbstractDataProvider	getDataProvider (*hash< auto > constructor_options)
	returns a data provider object for this connection
string	getType ()
	returns "esrest"

Protected Member Functions
RestClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a RestClient object

Detailed Description

ElasticSearch REST connection.

Member Function Documentation

constructor() [1/2]

ElasticSearchDataProvider::ElasticSearchRestConnection::constructor	(	hash< auto >	config,
		*hash< auto >	attr )

creates the ElasticSearchRestConnection object

Parameters

config

with the following keys: name (required string): the connection name display_name (optional string): the display name short_desc (optional string): a short description in plain text desc (optional string): a long description with markdown formatting url (required string): the connection URL opts (optional hash): connection options logger (optional LoggerInterface object): logger for the connection

attr

optional connection attributes monitor (optional bool): should the connection be monitored? Default: True enabled (optional bool): is the connection enabled? Default: True locked (optional bool): is the connection locked? Default: False debug_data (optional bool): debug data? Default: False tags (optional hash): tags for the connection; no default value

Exceptions

CONNECTION-OPTION-ERROR

missing or invalid connection option or attribute

constructor() [2/2]

ElasticSearchDataProvider::ElasticSearchRestConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {} )

creates the ElasticSearchRestConnection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

Exceptions

CONNECTION-OPTION-ERROR

missing or invalid connection option

getDataProvider()

DataProvider::AbstractDataProvider ElasticSearchDataProvider::ElasticSearchRestConnection::getDataProvider

(

*hash< auto >

constructor_options

)

returns a data provider object for this connection

Parameters

constructor_options

any additional constructor options for the data provider

Returns

a data provider object for this connection; the data provider is ElasticSearchDataProvider

getImpl()

RestClient ElasticSearchDataProvider::ElasticSearchRestConnection::getImpl ( bool connect = True, *hash< auto > rtopts )

protected

returns a RestClient object

Parameters

connect	if True, then the connection is returned already connected
rtopts	this connection type does not accept any runtime options, so this parameter is ignored

Returns

a RestClient object