The ElasticSearch read all indices API data provider. More...

Inheritance diagram for ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.

	constructor (RestClient::RestClient rest)
	Creates the object from a REST connection.

*string	getDesc ()
	Returns the data provider description.

string	getName ()
	Returns the data provider name.

hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Member Methods inherited from ElasticSearchDataProvider::ElasticSearchDataProviderBase
	constructor ()
	Creates the object.

	constructor (RestClient rest)
	Creates the object from a REST connection.

	setLogger (*LoggerInterface logger)
	Accepts a LoggerInterface object for logging (or clears it)

Public Attributes
const	ProviderInfo
	Provider info.

const	ProviderSummaryInfo
	Provider summary info.

const	QueryArgs = ElasticSearchIndexReadDataProvider::QueryArgs
	Query args.

const	RequestType = new ElasticSearchIndexReadAllRequestDataType()
	Request type.

const	ResponseType = new ElasticSearchIndexReadResponseDataType()
	Response type.

Private Member Methods
auto	doRequestImpl (auto req, *hash< auto > request_options)
	Makes a request and returns the response. More...

*DataProvider::AbstractDataProviderType	getRequestTypeImpl ()
	Returns the description of a successful request message, if any. More...

*DataProvider::AbstractDataProviderType	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message. More...

Detailed Description

The ElasticSearch read all indices API data provider.

This class implements an API that return the descriptions of all known indices in the ElasticSearch server.

Member Function Documentation

auto ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::doRequestImpl	(	auto	req,
		*hash< auto >	request_options
	)

private

Makes a request and returns the response.

Parameters

req	the request to serialize and make according to the request type
request_options	the request options; will be processed by validateRequestOptions()

*DataProvider::AbstractDataProviderType ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getRequestTypeImpl ( )

private

Returns the description of a successful request message, if any.

*DataProvider::AbstractDataProviderType ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getResponseTypeImpl ( )

private

Returns the description of a response message, if this object represents a response message.