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、レスポンス ステータスが失敗の場合は、false が返されます。
operator=(const SnapshotMetadata & copy_from)
別のオブジェクトからコピーして、この SnapshotMetadata オブジェクトを割り当てます。
operator=(SnapshotMetadata && move_from)
この SnapshotMetadata オブジェクトを別のオブジェクトに移動して、割り当てます。

パブリック関数

カバー画像 URL

const std::string & CoverImageURL() const

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

説明

const std::string & Description() const

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

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

FileName

const std::string & FileName() const

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

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

IsOpen（オープン）

bool IsOpen() const

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

Read、Commit、Resolve などのデータ関連のオペレーションは、オブジェクトにファイルデータがある場合にのみ機能します。定数であるにもかかわらず、この値はスナップショット メタデータの基になるデータに応じて変わります。たとえば、このオペレーションで Commit を呼び出すと、IsOpen() から false が返されます。

最終更新日時

Timestamp LastModifiedTime() const

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

再生時間

gpg::Duration PlayedTime() const

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

処理の進捗状況

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、レスポンス ステータスが失敗の場合は、false が返されます。

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

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

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

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

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

~SnapshotMetadata

 ~SnapshotMetadata()