Loading...
Searching...
No Matches
ElasticSearchIndexDeleteDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace ElasticSearchDataProvider {
class ElasticSearchIndexDeleteDataProvider : public ElasticSearchDataProviderBase {
public:
const ProviderInfo = <DataProviderInfo>{
"name": "delete",
"desc": "ElasticSearch index delete API data provider",
"type": "ElasticSearchIndexDeleteDataProvider",
"constructor_options": ElasticSearchDataProvider::ConstructorOptions,
"supports_request": True,
};
const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
AbstractDataProvider::DataProviderSummaryInfoKeys
});
const RequestType = new ElasticSearchIndexDeleteRequestDataType();
const ResponseType = new ElasticSearchAcknowledgedDataType();
const QueryArgs = ("allow_no_indices", "expand_wildcards", "ignore_unavailable", "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 ElasticSearchIndexDeleteRequestDataType : public DataProvider::HashDataType {
public:
protected:
const Fields = {
// query parameters
"index": {
"type": StringType,
"desc": "The name of the index to delete",
},
"allow_no_indices": {
"type": SoftBoolStringType,
"desc": "If `false` (default `true`), 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` (default `open,closed`). Valid values are:\n"
"- `all`: Match any data stream or index, including hidden ones\n"
"- `open`: 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",
},
"ignore_unavailable": {
"type": SoftBoolStringType,
"desc": "If `false, the request returns an error if it targets a missing or closed "
"index. Defaults to `false`",
},
"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",
},
};
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::ElasticSearchIndexDeleteDataProvider
The ElasticSearch index delete API data provider.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:30
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::constructor
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::ResponseType
const ResponseType
Response type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:51
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::getDesc
*string getDesc()
Returns the data provider description.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:43
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::QueryArgs
const QueryArgs
Query args.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:54
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::getName
string getName()
Returns the data provider name.
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::RequestType
const RequestType
Request type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:48
ElasticSearchDataProvider::ElasticSearchIndexDeleteDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:34
ElasticSearchDataProvider::ElasticSearchIndexDeleteRequestDataType
Index delete API request data type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:105
ElasticSearchDataProvider::ElasticSearchIndexDeleteRequestDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchIndexDeleteRequestDataType::Fields
const Fields
Field descriptions.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:110
ElasticSearchDataProvider::SoftBoolStringType
Boolean string type.
Definition: ElasticSearchDataProvider.qc.dox.h:141
RestClient::RestClient
ElasticSearchDataProvider
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26