![]() |
Qore ElasticSearchDataProvider Module Reference 1.0
|
The ElasticSearch index read API data provider. More...
#include <ElasticSearchIndexReadDataProvider.qc.dox.h>
Inherits AbstractDataProvider.
Public Member Functions | |
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 Attributes | |
const | ProviderInfo |
Provider info. | |
const | ProviderSummaryInfo |
Provider summary info. | |
const | QueryArgs = ... |
Query args. | |
const | RequestType = new ElasticSearchIndexReadRequestDataType() |
Request type. | |
const | ResponseType = new ElasticSearchIndexReadResponseDataType() |
Response type. | |
RestClient::RestClient | rest |
REST client connection. | |
Protected Member Functions | |
auto | doRequestImpl (auto req, *hash< auto > request_options) |
Makes a request and returns the response. | |
*DataProvider::AbstractDataProviderType | getRequestTypeImpl () |
Returns the description of a successful request message, if any. | |
*DataProvider::AbstractDataProviderType | getResponseTypeImpl () |
Returns the description of a response message, if this object represents a response message. | |
The ElasticSearch index read API data provider.
This class implements an API that reads index data given the index name as an argument; the response is the description of the index as returned by the ElasticSearch server.
Note that wildcards can be used, in which case multiple indices can be returned in the return value.
|
protected |
Makes a request and returns the response.
req | the request to serialize and make according to the request type |
request_options | the request options; will be processed by validateRequestOptions() |
|
protected |
Returns the description of a successful request message, if any.
|
protected |
Returns the description of a response message, if this object represents a response message.