Loading...
Searching...
No Matches
ElasticSearchIndexCreateDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace ElasticSearchDataProvider {
class ElasticSearchIndexCreateDataProvider : public ElasticSearchDataProviderBase {
public:
const ProviderInfo = <DataProviderInfo>{
"name": "create",
"desc": "ElasticSearch index create API data provider",
"type": "ElasticSearchIndexCreateDataProvider",
"constructor_options": ElasticSearchDataProvider::ConstructorOptions,
"supports_request": True,
};
const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
AbstractDataProvider::DataProviderSummaryInfoKeys
});
const RequestType = new ElasticSearchIndexCreateRequestDataType();
const ResponseType = new ElasticSearchIndexCreateResponseDataType();
const QueryArgs = ("wait_for_active_shards", "master_timeout", "timeout");
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 ElasticSearchIndexAliasesDataType : public DataProvider::HashDataType {
public:
constructor() ;
};
class ElasticSearchIndexCreateRequestDataType : public ElasticSearchIndexDataTypeBase {
public:
protected:
const Fields = {
// query parameters
"index": {
"type": StringType,
"desc": "The name of the index to create",
},
"wait_for_active_shards": {
"type": SoftStringOrNothingType,
"desc": "The number of shard copies that must be active before proceeding with the operation. "
"Set to `all` or any positive integer up to the total number of shards in the "
"index (number_of_replicas+1). Default: `1`, the primary shard.",
},
"master_timeout": {
"type": StringOrNothingType,
"desc": "Period to wait for a connection to the master node (default `30s`). If no response is "
"received before the timeout expires, the request fails and returns an error",
},
"timeout": {
"type": StringOrNothingType,
"desc": "Period to wait for a response (default `30s`). If no response is received before the "
"timeout expires, the request fails and returns an error",
},
# body parameters
"aliases": {
"type": new ElasticSearchIndexAliasesDataType(),
"desc": "The key is the alias name. Index alias names support date math",
},
"mappings": {
"type": AutoHashOrNothingType,
"desc": "Mapping for fields in the index. If specified, this mapping can include:\n"
"- Field names\n"
"- Field data types\n"
"- Mapping parameters",
},
"settings": {
"type": AutoHashOrNothingType,
"desc": "Configuration options for the index",
},
};
public:
constructor();
};
class ElasticSearchIndexCreateResponseDataType : public ElasticSearchAcknowledgedDataType {
public:
protected:
const Fields = {
"shards_acknowledged": {
"type": BoolType,
"desc": "Indicates whether the requisite number of shard copies were started for each shard in the "
"index before timing out",
},
"index": {
"type": StringType,
"desc": "The name of the index created",
},
};
public:
constructor();
};
};
DataProvider::AbstractDataProviderType
DataProvider::HashDataType
ElasticSearchDataProvider::ElasticSearchAcknowledgedDataType
The acknowledged response type.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:28
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::ElasticSearchIndexAliasesDataType
Aliases data type.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:105
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider
The ElasticSearch index create API data provider.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:30
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:43
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::constructor
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::ResponseType
const ResponseType
Response type.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:51
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::RequestType
const RequestType
Request type.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:48
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::getName
string getName()
Returns the data provider name.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::QueryArgs
const QueryArgs
Query args.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:54
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::getDesc
*string getDesc()
Returns the data provider description.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:34
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearchDataProvider::ElasticSearchIndexCreateDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
ElasticSearchDataProvider::ElasticSearchIndexCreateRequestDataType
Create index request data type.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:113
ElasticSearchDataProvider::ElasticSearchIndexCreateRequestDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchIndexCreateRequestDataType::Fields
const Fields
Field descriptions.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:118
ElasticSearchDataProvider::ElasticSearchIndexCreateResponseDataType
Index create API response.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:167
ElasticSearchDataProvider::ElasticSearchIndexCreateResponseDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchIndexCreateResponseDataType::Fields
const Fields
Field descriptions.
Definition: ElasticSearchIndexCreateDataProvider.qc.dox.h:172
ElasticSearchDataProvider::ElasticSearchIndexDataTypeBase
Base data type for search request types.
Definition: ElasticSearchIndexDataTypeBase.qc.dox.h:28
RestClient::RestClient
ElasticSearchDataProvider
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26