ファイルバケット. [詳細]

#include "necbaas/nb_file_bucket.h"

Public メソッド
	NbFileBucket (const std::shared_ptr< NbService > &service, const std::string &bucket_name)
	コンストラクタ. [詳細]

	~NbFileBucket ()
	デストラクタ. [詳細]

NbResult< int >	DownloadFile (const std::string &file_name, const std::string &file_path)
	ファイルダウンロード. [詳細]

NbResult< NbFileMetadata >	UploadNewFile (const std::string &file_name, const std::string &file_path, const std::string &content_type, const NbAcl &acl, bool cache_disable=false)
	ファイルの新規アップロード. [詳細]

NbResult< NbFileMetadata >	UploadNewFile (const std::string &file_name, const std::string &file_path, const std::string &content_type, bool cache_disable=false)
	ファイルの新規アップロード(ACLなし). [詳細]

NbResult< NbFileMetadata >	UploadUpdateFile (const std::string &file_path, const NbFileMetadata &metadata)
	ファイルの更新アップロード. [詳細]

NbResult< NbFileMetadata >	UploadUpdateFile (const std::string &file_name, const std::string &file_path, const std::string &content_type, const std::string &meta_etag, const std::string &file_etag)
	ファイルの更新アップロード. [詳細]

NbResult< NbFileMetadata >	DeleteFile (const NbFileMetadata &metadata, bool delete_mark=false)
	ファイル削除. [詳細]

NbResult< NbFileMetadata >	DeleteFile (const std::string &file_name, const std::string &meta_etag, const std::string &file_etag, bool delete_mark=false)
	ファイル削除. [詳細]

NbResult< std::vector < NbFileMetadata > >	GetFiles (bool published=false, bool deleteMark=false)
	ファイル一覧取得. [詳細]

int	GetTimeout () const
	RESTタイムアウト取得. [詳細]

void	SetTimeout (int timeout)
	RESTタイムアウト設定. [詳細]

const std::string &	GetBucketName () const
	バケット名取得. [詳細]

説明

ファイルバケット.

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

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

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

コンストラクタ.

引数

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

necbaas::NbFileBucket::~NbFileBucket ( )

デストラクタ.

関数

NbResult<NbFileMetadata> necbaas::NbFileBucket::DeleteFile	(	const NbFileMetadata &	metadata,
		bool	delete_mark = `false`
	)

ファイル削除.

処理成功データ(メタデータ)は、delete_markにtrueを指定したときのみ有効である。
metadata内に設定されたfile_name等の情報を使用してファイル削除を行う。
metadata内の file_name が空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。

引数

[in]	metadata	メタデータ
[in]	delete_mark	削除マークのみを行う

戻り値: 処理結果

NbResult<NbFileMetadata> necbaas::NbFileBucket::DeleteFile	(	const std::string &	file_name,
		const std::string &	meta_etag,
		const std::string &	file_etag,
		bool	delete_mark = `false`
	)

ファイル削除.

処理成功データ(メタデータ)は、delete_markにtrueを指定したときのみ有効である。
file_nameが空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。
meta_etag, file_etagを設定しない場合は、空文字を設定すること。

引数

[in]	metadata	メタデータ
[in]	delete_mark	削除マークのみを行う

戻り値: 処理結果

NbResult<int> necbaas::NbFileBucket::DownloadFile	(	const std::string &	file_name,
		const std::string &	file_path
	)

ファイルダウンロード.

file_pathにファイルが存在する場合、上書き保存となる。
ダウンロード中にエラーを検出した場合、その時点までのデータが保存されたファイルが作成される。
file_name, file_pathが空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。

引数

[in]	file_name	ダウンロードするファイルの名前
[in]	file_path	ダウンロードしたファイルの保存先

戻り値: 処理結果

const std::string& necbaas::NbFileBucket::GetBucketName ( ) const

バケット名取得.

戻り値: バケット名

NbResult<std::vector<NbFileMetadata> > necbaas::NbFileBucket::GetFiles	(	bool	published = `false`,
		bool	deleteMark = `false`
	)

ファイル一覧取得.

bucket_nameが空文字の場合、バケット名不正のエラーを返す。

引数

[in]	published	公開済みファイルのメタデータ一覧の取得用のフラグ
[in]	delete_mark	削除マークされたデータを読み込む

戻り値: 処理結果

int necbaas::NbFileBucket::GetTimeout ( ) const

RESTタイムアウト取得.

戻り値: タイムアウト(秒)

void necbaas::NbFileBucket::SetTimeout ( int timeout )

RESTタイムアウト設定.

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

引数

[in] timeout タイムアウト(秒)

NbResult<NbFileMetadata> necbaas::NbFileBucket::UploadNewFile	(	const std::string &	file_name,
		const std::string &	file_path,
		const std::string &	content_type,
		const NbAcl &	acl,
		bool	cache_disable = `false`
	)

ファイルの新規アップロード.

file_name, file_path, content_typeが空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。
明示的にACLを設定しない場合はオーバーロードメソッドを使用すること。

引数

[in]	file_name	アップロードするファイルの名前
[in]	file_path	アップロードするローカルファイルのパス
[in]	content_type	Content-Type
[in]	acl	ACL
[in]	cache_disable	キャッシュ禁止フラグ

戻り値: 処理結果

NbResult<NbFileMetadata> necbaas::NbFileBucket::UploadNewFile	(	const std::string &	file_name,
		const std::string &	file_path,
		const std::string &	content_type,
		bool	cache_disable = `false`
	)

ファイルの新規アップロード(ACLなし).

file_name, file_path, content_typeが空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。

引数

[in]	file_name	アップロードするファイルの名前
[in]	file_path	アップロードするローカルファイルのパス
[in]	content_type	Content-Type
[in]	cache_disable	キャッシュ禁止フラグ

戻り値: 処理結果

NbResult<NbFileMetadata> necbaas::NbFileBucket::UploadUpdateFile	(	const std::string &	file_path,
		const NbFileMetadata &	metadata
	)

ファイルの更新アップロード.

metadata内に設定されたfile_name等の情報を使用してファイルアップロードを行う。
metadata内の file_name, file_path, content_typeが空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。

引数

[in]	file_path	アップロードするローカルファイルのパス
[in]	metadata	メタデータ

戻り値: 処理結果

NbResult<NbFileMetadata> necbaas::NbFileBucket::UploadUpdateFile	(	const std::string &	file_name,
		const std::string &	file_path,
		const std::string &	content_type,
		const std::string &	meta_etag,
		const std::string &	file_etag
	)

ファイルの更新アップロード.

file_name, file_path, content_typeが空文字の場合、パラメータ不正のエラーを返す。
bucket_nameが空文字の場合、バケット名不正のエラーを返す。
content_type, meta_etag, file_etagを設定しない場合は、空文字を設定すること。

引数

[in]	file_name	アップロードするファイルの名前
[in]	file_path	アップロードするローカルファイルのパス
[in]	content_type	Content-Type
[in]	meta_etag	メタデータのETag
[in]	file_etag	ファイル本体のデータのETag

戻り値: 処理結果

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

nb_file_bucket.h

Public メソッド

説明

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

関数