gpg::SnapshotMetadata

#include <snapshot_metadata.h>

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

概要

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

コンストラクタとデストラクタ
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 オブジェクトからコピーして、この SnapshotMetadata オブジェクトを割り当てます。
operator=(SnapshotMetadata && move_from)
別の SnapshotMetadata オブジェクトをこの SnapshotMetadata オブジェクトに移動して、この SnapshotMetadata オブジェクトを割り当てます。

パブリック関数

CoverImageURL

const std::string & CoverImageURL() const

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

説明

const std::string & Description() const

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

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

FileName

const std::string & FileName() const

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

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

IsOpen

bool IsOpen() const

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

Read、Commit、Resolve などのデータ関連のオペレーションは、オブジェクトにファイルデータが存在する場合にのみ機能します。const であるにもかかわらず、この値はスナップショット メタデータの基盤となるデータを反映するように変更されます。たとえば、オペレーションで 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 オブジェクトからコピーして、この SnapshotMetadata オブジェクトを割り当てます。

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

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

~SnapshotMetadata

 ~SnapshotMetadata()