hyperledger/iroha
Iroha - A simple, decentralized ledger http://iroha.tech
Public Member Functions | Static Public Attributes | Friends | List of all members
shared_model::proto::TemplateQueryBuilder< S, SV, BT > Class Template Reference

#include "query_template.hpp"

Collaboration diagram for shared_model::proto::TemplateQueryBuilder< S, SV, BT >:
Collaboration graph

Public Member Functions

 TemplateQueryBuilder ()
 
auto createdTime (interface::types::TimestampType created_time) const
 
auto creatorAccountId (const interface::types::AccountIdType &creator_account_id) const
 
auto queryCounter (interface::types::CounterType query_counter) const
 
auto getAccount (const interface::types::AccountIdType &account_id) const
 
auto getSignatories (const interface::types::AccountIdType &account_id) const
 
auto getAccountTransactions (const interface::types::AccountIdType &account_id, interface::types::TransactionsNumberType page_size, const std::optional< interface::types::HashType > &first_hash=std::nullopt, const interface::Ordering *ordering=nullptr, const std::optional< interface::types::TimestampType > &first_tx_time=std::nullopt, const std::optional< interface::types::TimestampType > &last_tx_time=std::nullopt, const std::optional< interface::types::HeightType > &first_tx_height=std::nullopt, const std::optional< interface::types::HeightType > &last_tx_height=std::nullopt) const
 
auto getAccountAssetTransactions (const interface::types::AccountIdType &account_id, const interface::types::AssetIdType &asset_id, interface::types::TransactionsNumberType page_size, const std::optional< interface::types::HashType > &first_hash=std::nullopt, const interface::Ordering *ordering=nullptr, const std::optional< interface::types::TimestampType > &first_tx_time=std::nullopt, const std::optional< interface::types::TimestampType > &last_tx_time=std::nullopt, const std::optional< interface::types::HeightType > &first_tx_height=std::nullopt, const std::optional< interface::types::HeightType > &last_tx_height=std::nullopt) const
 
auto getAccountAssets (const interface::types::AccountIdType &account_id, size_t page_size, std::optional< shared_model::interface::types::AssetIdType > first_asset_id) const
 
auto getAccountDetail (size_t page_size, const interface::types::AccountIdType &account_id="", const interface::types::AccountDetailKeyType &key="", const interface::types::AccountIdType &writer="", const std::optional< plain::AccountDetailRecordId > &first_record_id=std::nullopt)
 
auto getBlock (interface::types::HeightType height) const
 
auto getEngineReceipts (std::string_view tx_hash)
 
auto getRoles () const
 
auto getAssetInfo (const interface::types::AssetIdType &asset_id) const
 
auto getRolePermissions (const interface::types::RoleIdType &role_id) const
 
template<typename Collection >
auto getTransactions (const Collection &hashes) const
 
auto getTransactions (std::initializer_list< interface::types::HashType > hashes) const
 
template<typename... Hash>
auto getTransactions (const Hash &... hashes) const
 
auto getPendingTransactions () const
 
auto getPendingTransactions (interface::types::TransactionsNumberType page_size, const std::optional< interface::types::HashType > &first_hash=std::nullopt) const
 
auto getPeers () const
 
auto build () const
 

Static Public Attributes

static const int total = RequiredFields::TOTAL
 

Friends

template<int , typename , typename >
class TemplateQueryBuilder
 

Detailed Description

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
class shared_model::proto::TemplateQueryBuilder< S, SV, BT >

Template query builder for creating new types of query builders by means of replacing template parameters

Template Parameters
S– field counter for checking that all required fields are set
SV– stateless validator called when build method is invoked
BT– build type of built object returned by build method

Constructor & Destructor Documentation

◆ TemplateQueryBuilder()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
shared_model::proto::TemplateQueryBuilder< S, SV, BT >::TemplateQueryBuilder ( )
inline

Member Function Documentation

◆ build()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::build ( ) const
inline

◆ createdTime()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::createdTime ( interface::types::TimestampType  created_time) const
inline

◆ creatorAccountId()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::creatorAccountId ( const interface::types::AccountIdType &  creator_account_id) const
inline

◆ getAccount()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getAccount ( const interface::types::AccountIdType &  account_id) const
inline

◆ getAccountAssets()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getAccountAssets ( const interface::types::AccountIdType &  account_id,
size_t  page_size,
std::optional< shared_model::interface::types::AssetIdType >  first_asset_id 
) const
inline

◆ getAccountAssetTransactions()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getAccountAssetTransactions ( const interface::types::AccountIdType &  account_id,
const interface::types::AssetIdType &  asset_id,
interface::types::TransactionsNumberType  page_size,
const std::optional< interface::types::HashType > &  first_hash = std::nullopt,
const interface::Ordering *  ordering = nullptr,
const std::optional< interface::types::TimestampType > &  first_tx_time = std::nullopt,
const std::optional< interface::types::TimestampType > &  last_tx_time = std::nullopt,
const std::optional< interface::types::HeightType > &  first_tx_height = std::nullopt,
const std::optional< interface::types::HeightType > &  last_tx_height = std::nullopt 
) const
inline

◆ getAccountDetail()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getAccountDetail ( size_t  page_size,
const interface::types::AccountIdType &  account_id = "",
const interface::types::AccountDetailKeyType &  key = "",
const interface::types::AccountIdType &  writer = "",
const std::optional< plain::AccountDetailRecordId > &  first_record_id = std::nullopt 
)
inline

◆ getAccountTransactions()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getAccountTransactions ( const interface::types::AccountIdType &  account_id,
interface::types::TransactionsNumberType  page_size,
const std::optional< interface::types::HashType > &  first_hash = std::nullopt,
const interface::Ordering *  ordering = nullptr,
const std::optional< interface::types::TimestampType > &  first_tx_time = std::nullopt,
const std::optional< interface::types::TimestampType > &  last_tx_time = std::nullopt,
const std::optional< interface::types::HeightType > &  first_tx_height = std::nullopt,
const std::optional< interface::types::HeightType > &  last_tx_height = std::nullopt 
) const
inline

◆ getAssetInfo()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getAssetInfo ( const interface::types::AssetIdType &  asset_id) const
inline

◆ getBlock()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getBlock ( interface::types::HeightType  height) const
inline

◆ getEngineReceipts()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getEngineReceipts ( std::string_view  tx_hash)
inline

◆ getPeers()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getPeers ( ) const
inline

◆ getPendingTransactions() [1/2]

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getPendingTransactions ( ) const
inline

◆ getPendingTransactions() [2/2]

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getPendingTransactions ( interface::types::TransactionsNumberType  page_size,
const std::optional< interface::types::HashType > &  first_hash = std::nullopt 
) const
inline

◆ getRolePermissions()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getRolePermissions ( const interface::types::RoleIdType &  role_id) const
inline

◆ getRoles()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getRoles ( ) const
inline

◆ getSignatories()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getSignatories ( const interface::types::AccountIdType &  account_id) const
inline

◆ getTransactions() [1/3]

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
template<typename Collection >
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getTransactions ( const Collection &  hashes) const
inline
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getTransactions() [2/3]

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getTransactions ( std::initializer_list< interface::types::HashType >  hashes) const
inline
Here is the call graph for this function:

◆ getTransactions() [3/3]

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
template<typename... Hash>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::getTransactions ( const Hash &...  hashes) const
inline
Here is the call graph for this function:

◆ queryCounter()

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
auto shared_model::proto::TemplateQueryBuilder< S, SV, BT >::queryCounter ( interface::types::CounterType  query_counter) const
inline

Friends And Related Function Documentation

◆ TemplateQueryBuilder

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
template<int , typename , typename >
friend class TemplateQueryBuilder
friend

Member Data Documentation

◆ total

template<int S = 0, typename SV = validation::DefaultUnsignedQueryValidator, typename BT = UnsignedWrapper<Query>>
const int shared_model::proto::TemplateQueryBuilder< S, SV, BT >::total = RequiredFields::TOTAL
static
The documentation for this class was generated from the following file: