Loading...
Searching...
No Matches
ElasticSearchIndexReadDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace ElasticSearchDataProvider {
class ElasticSearchIndexReadDataProvider : public ElasticSearchDataProviderBase {
public:
const ProviderInfo = <DataProviderInfo>{
"name": "read",
"desc": "ElasticSearch index read API data provider",
"type": "ElasticSearchIndexReadDataProvider",
"constructor_options": ElasticSearchDataProvider::ConstructorOptions,
"supports_request": True,
};
const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
AbstractDataProvider::DataProviderSummaryInfoKeys
});
const RequestType = new ElasticSearchIndexReadRequestDataType();
const ResponseType = new ElasticSearchIndexReadResponseDataType();
const QueryArgs = ...;
constructor(*hash<auto> options);
constructor(RestClient::RestClient rest) ;
string getName();
*string getDesc();
protected:
auto doRequestImpl(auto req, *hash<auto> request_options);
public:
protected:
*DataProvider::AbstractDataProviderType getRequestTypeImpl();
public:
protected:
*DataProvider::AbstractDataProviderType getResponseTypeImpl();
public:
hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
};
class ElasticSearchIndexReadRequestDataType : public DataProvider::HashDataType {
public:
const Fields = {
// query parameters
"index": {
"type": StringType,
"desc": "The name of the index to read",
},
"allow_no_indices": {
"type": SoftBoolStringType,
"desc": "f `false`, the request returns an error if any wildcard expression, index alias, or `_all` "
"value targets only missing or closed indices. This behavior applies even if the request targets "
"other open indices. For example, a request targeting `foo*,bar*` returns an error if an index "
"starts with `foo` but no index starts with `bar`",
},
"expand_wildcards": {
"type": StringOrNothingType,
"desc": "Type of index that wildcard patterns can match. If the request can target data streams, "
"this argument determines whether wildcard expressions match hidden data streams. Supports "
"comma-separated values, such as open,hidden. Valid values are:\n"
"- `all`: Match any data stream or index, including hidden ones\n"
"- `open`: (default) Match open, non-hidden indices. Also matches any non-hidden data stream.\n"
"- `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data "
"streams cannot be closed\n"
"- `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, "
"`closed`, or both\n"
"- `none`: Wildcard patterns are not accepted",
},
"features": {
"type": StringOrNothingType,
"desc": "Return information about specific index features. Supports comma-separated values. Valid "
"values are: `aliases`, `mappings`, and `settings`.",
},
"flat_settings": {
"type": SoftBoolStringType,
"desc": "If `true`, returns settings in flat format",
},
"include_defaults": {
"type": SoftBoolStringType,
"desc": "If `true`, return all default settings in the response",
},
"ignore_unavailable": {
"type": SoftBoolStringType,
"desc": "If `false`, the request returns an error if it targets a missing or closed index",
},
"master_timeout": {
"type": StringOrNothingType,
"desc": "Period to wait for a connection to the master node. If no response is received before the "
"timeout expires, the request fails and returns an error",
},
};
constructor();
};
class ElasticSearchIndexReadResponseDataType : public HashDataType {
public:
constructor();
};
};
DataProvider::AbstractDataProviderType
DataProvider::HashDataType
ElasticSearchDataProvider::ElasticSearchDataProviderBase
The AWS REST client base data provider class.
Definition: ElasticSearchDataProviderBase.qc.dox.h:28
ElasticSearchDataProvider::ElasticSearchDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:61
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider
The ElasticSearch index read API data provider.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:33
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getDesc
*string getDesc()
Returns the data provider description.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::QueryArgs
const QueryArgs
Query args.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:57
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:46
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::RequestType
const RequestType
Request type.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:51
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::constructor
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getName
string getName()
Returns the data provider name.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::ResponseType
const ResponseType
Response type.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:54
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:37
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearchDataProvider::ElasticSearchIndexReadRequestDataType
ElasticSearch index read API request.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:109
ElasticSearchDataProvider::ElasticSearchIndexReadRequestDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchIndexReadRequestDataType::Fields
const Fields
Field descriptions.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:113
ElasticSearchDataProvider::ElasticSearchIndexReadResponseDataType
ElasticSearch index read API response.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:169
ElasticSearchDataProvider::ElasticSearchIndexReadResponseDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::SoftBoolStringType
Boolean string type.
Definition: ElasticSearchDataProvider.qc.dox.h:141
RestClient::RestClient
ElasticSearchDataProvider
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26