gpg::SnapshotMetadata

#include <snapshot_metadata.h>

特定のスナップショット メタデータのステータスに関するデータにアクセスできる単一のデータ構造。

概要

他の値の型とは異なり、SnapshotMetadata は厳密に不変ではありません。SnapshotManager API が「閉じる」ことができるスナップショット。IsOpen() メソッドの結果を変更します。このような API では、SnapshotMetadata を IsOpen() で渡す必要があります。

コンストラクタとデストラクタ
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
shared_ptr から SnapshotMetadataImpl への SnapshotMetadata オブジェクトを構築します。
SnapshotMetadata(const SnapshotMetadata & copy_from)
既存の SnapshotMetadata オブジェクトのコピーを作成します。
SnapshotMetadata(SnapshotMetadata && move_from)
既存の SnapshotMetadata オブジェクトを移動します。
~SnapshotMetadata()

パブリック関数
CoverImageURL() const
const std::string &
カバー画像の URL を返します。
Description() const
const std::string &
スナップショット メタデータの簡潔な説明を返します。
FileName() const
const std::string &
スナップショットのファイル名と一意の識別子を返します。
IsOpen() const
bool
返されたスナップショット メタデータが一致するファイルデータで読み込まれた場合に true を返します。
LastModifiedTime() const
エントリが最後に変更された時刻を返します（Unix エポックからのミリ秒数で表されます）。
PlayedTime() const
このスナップショット メタデータに関連付けられている再生時間を返します。
ProgressValue() const
int64_t
このスナップショット メタデータに関連付けられている設定進行状況値を返します。
Valid() const
bool
返されたスナップショット メタデータにデータが入力され、正常なレスポンス ステータスとともにある場合、true を返します。データが入力されていないユーザー作成スナップショットの場合、または入力失敗時のレスポンスステータスを伴うスナップショットの場合は false。
operator=(const SnapshotMetadata & copy_from)
別のオブジェクトからコピーすることで、この SnapshotMetadata オブジェクトを割り当てます。
operator=(SnapshotMetadata && move_from)
この SnapshotMetadata オブジェクトを、別のオブジェクトを移動して割り当てます。

パブリック関数

CoverImageURL

const std::string & CoverImageURL() const

カバー画像の URL を返します。

説明

const std::string & Description() const

スナップショット メタデータの簡潔な説明を返します。

この関数を使用するには、SnapshotMetadata::Valid() が true を返す必要があります。

FileName

const std::string & FileName() const

スナップショットのファイル名と一意の識別子を返します。

スナップショット名は、URL 予約されていない文字（a ～ z、A ～ Z、0 ～ 9、または記号「-」、「.」、「_」、「~」）で 1 ～ 100 文字にする必要があります。

IsOpen

bool IsOpen() const

返されたスナップショット メタデータが一致するファイルデータで読み込まれた場合に true を返します。

Read、Commit、Resolve などのデータ関連のオペレーションは、オブジェクトにファイルデータがある場合にのみ機能します。一定であっても、この値はスナップショット メタデータの基になるデータを反映するように変化します。たとえば、オペレーションに対して Commit を呼び出すと、IsOpen() は false を返します。

LastModifiedTime

Timestamp LastModifiedTime() const

エントリが最後に変更された時刻を返します（Unix エポックからのミリ秒数で表されます）。

PlayedTime

gpg::Duration PlayedTime() const

このスナップショット メタデータに関連付けられている再生時間を返します。

ProgressValue

int64_t ProgressValue() const

このスナップショット メタデータに関連付けられている設定進行状況値を返します。

進行状況の値は、競合の自動解決に使用されます。

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

shared_ptr から SnapshotMetadataImpl への SnapshotMetadata オブジェクトを構築します。

API の内部で使用することを目的としています。

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

既存の SnapshotMetadata オブジェクトのコピーを作成します。

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

既存の SnapshotMetadata オブジェクトを移動します。

有効

bool Valid() const

返されたスナップショット メタデータにデータが入力され、正常なレスポンス ステータスとともにある場合、true を返します。データが入力されていないユーザー作成スナップショットの場合、または入力失敗時のレスポンスステータスを伴うスナップショットの場合は false。

この関数は、このスナップショットのゲッター関数（id、Name、Description など）が使用可能になる場合に true を返す必要があります。

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

別のオブジェクトからコピーすることで、この SnapshotMetadata オブジェクトを割り当てます。

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

この SnapshotMetadata オブジェクトを、別のオブジェクトを移動して割り当てます。

~SnapshotMetadata

 ~SnapshotMetadata()