クラス necbaas::NbObjectBucket

オブジェクトバケット. [詳細]

#include "necbaas/nb_object_bucket.h"

Public メソッド
	NbObjectBucket (const std::shared_ptr< NbService > &service, const std::string &bucket_name)
	コンストラクタ. [詳細]
	~NbObjectBucket ()
	デストラクタ. [詳細]
NbResult< NbObject >	GetObject (const std::string &object_id, bool delete_mark=false)
	オブジェクトID検索. [詳細]
NbResult< std::vector< NbObject > >	Query (const NbQuery &query, int *count=nullptr)
	オブジェクトのクエリ. [詳細]
int	GetTimeout () const
	RESTタイムアウト取得. [詳細]
void	SetTimeout (int timeout)
	RESTタイムアウト設定. [詳細]
NbObject	NewObject ()
	オブジェクト生成する. [詳細]
const std::string &	GetBucketName () const
	バケット名取得. [詳細]

説明

オブジェクトバケット.

本クラスのインスタンスはスレッドセーフではない

コンストラクタとデストラクタ

necbaas::NbObjectBucket::NbObjectBucket	(	const std::shared_ptr< NbService > &	service,
		const std::string &	bucket_name
	)

コンストラクタ.

引数

[in]	service	サービスインスタンス
[in]	bucket_name	バケット名

necbaas::NbObjectBucket::~NbObjectBucket

(

)

デストラクタ.

関数

const std::string& necbaas::NbObjectBucket::GetBucketName

(

)

const

バケット名取得.

戻り値

バケット名

NbResult<NbObject> necbaas::NbObjectBucket::GetObject	(	const std::string &	object_id,
		bool	delete_mark = false
	)

オブジェクトID検索.

オブジェクトIDが空文字の場合は、パラメータエラーを返す。
インスタンスに設定されているバケット名が空文字の場合は、バケット名エラーを返す。
delete_markがtrueの場合、削除マークされたデータも読み込まれる。

引数

[in]	object_id	オブジェクトID
[in]	delete_mark	削除マークされたデータを読み込む

戻り値

処理結果

int necbaas::NbObjectBucket::GetTimeout

(

)

const

RESTタイムアウト取得.

戻り値

タイムアウト(秒)

NbObject necbaas::NbObjectBucket::NewObject

(

)

オブジェクト生成する.

戻り値

新規オブジェクト

NbResult<std::vector<NbObject> > necbaas::NbObjectBucket::Query	(	const NbQuery &	query,
		int *	count = nullptr
	)

オブジェクトのクエリ.

インスタンスに設定されているバケット名が空文字の場合は、バケット名エラーを返す。
条件に合致した全件数を取得する場合は、countパラメータに値設定用アドレスを設定する。
クエリに成功した場合、countに件数が設定される。

引数

[in]	query	検索条件
[out]	count	件数取得

戻り値

処理結果

void necbaas::NbObjectBucket::SetTimeout

(

int

timeout

)

RESTタイムアウト設定.

RESTのタイムアウト値(秒)を設定する。
0以下の値が設定された場合は、デフォルト値(60秒)が設定される。

引数

[in]

timeout

タイムアウト(秒)

---

このクラスの説明は次のファイルから生成されました:

• nb_object_bucket.h