17.3. GetActiveRestoreProcess
GET /v1/db/restore
17.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
17.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
17.3.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
17.3.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
17.3.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
| コード | メッセージ | データタイプ |
|---|---|---|
| 200 | 正常な応答。 | |
| 0 | 予期しないエラーの応答です。 |
17.3.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
17.3.7. 共通のオブジェクト参照 リンクのコピーリンクがクリップボードにコピーされました!
17.3.7.1. DBExportManifestEncodingType リンクのコピーリンクがクリップボードにコピーされました!
復元本文内のファイルデータのエンコード。通常は圧縮目的で使用されます。
| Enum 値 |
|---|
| UNKNOWN |
| UNCOMPREESSED |
| DEFLATED |
17.3.7.2. DBRestoreProcessStatusResumeInfo リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| pos | String | int64 |
17.3.7.3. DBRestoreRequestHeaderLocalFileInfo リンクのコピーリンクがクリップボードにコピーされました!
LocalFileInfo は、進行中の復元プロセスに関する情報を他のユーザーに提供するために、復元プロセスを開始するユーザーのローカルマシン上のファイルに関する情報を提供します。
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| path | String | ファイルの完全パス。 | |||
| bytesSize | String | ファイルのサイズ(バイト単位)。不明な場合は 0。 | int64 |
17.3.7.4. ProtobufAny リンクのコピーリンクがクリップボードにコピーされました!
any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。
例 1: C++ のメッセージをパックして展開します。
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
例 2: Java でメッセージをパックして解凍します。
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
protobuf ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。
17.3.7.4.1. JSON 表現 リンクのコピーリンクがクリップボードにコピーされました!
Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
| value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
17.3.7.5. RuntimeError リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | ProtobufAnyのリスト |
17.3.7.6. V1DBExportManifest リンクのコピーリンクがクリップボードにコピーされました!
DB エクスポートマニフェストは、復元リクエストのファイルの内容を説明します。データの損失を防ぐために、マニフェストは常にバインディングとして解釈されます。つまり、サーバーはマニフェストにリストされているすべてのファイルを読み取り、使用するようにする必要があります。そうでない場合は、要求を拒否する必要があります。
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| files |
17.3.7.7. V1DBExportManifestFile リンクのコピーリンクがクリップボードにコピーされました!
復元本文の 1 つのファイル。
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| name | String | ファイルの名前。これは、(相対)ファイルパスであり、解釈するサーバーまでの場合とそうでない場合があります。ZIP ファイルとしてエクスポートされるデータベースの場合、これはアーカイブのルートに対する相対パスです。 | |||
| encoding | UNKNOWN、UNCOMPREESSED、DEFLATED、 | ||||
| encodedSize | String | int64 | |||
| decodedSize | String | int64 | |||
| decodedCrc32 | Long | デコードされた(!)データの CRC32 (IEEE)チェックサム。 | int64 |
17.3.7.8. V1DBRestoreProcessMetadata リンクのコピーリンクがクリップボードにコピーされました!
進行中の復元プロセスまたは完了した復元プロセスのメタデータ。これは 静的 なメタデータで、変更されません(つまりステータスではありません)。
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | 復元プロセスを識別する ID。Auto-assigned。 | |||
| header | |||||
| startTime | Date | 復元プロセスが開始された時間。 | date-time | ||
| initiatingUserName | String | データベースの復元プロセスを開始したユーザー。 |
17.3.7.9. V1DBRestoreProcessStatus リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| metadata | |||||
| attemptId | String | ||||
| state | UNKNOWN, NOT_STARTED, IN_PROGRESS, PAUSED, COMPLETED, | ||||
| resumeInfo | |||||
| error | String | ||||
| bytesRead | String | int64 | |||
| filesProcessed | String | int64 |
17.3.7.10. V1DBRestoreProcessStatusState リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| UNKNOWN |
| NOT_STARTED |
| IN_PROGRESS |
| PAUSED |
| COMPLETED |
17.3.7.11. V1DBRestoreRequestHeader リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| formatName | String | データベースエクスポート形式の名前。必須。 | |||
| マニフェスト | |||||
| localFile |
17.3.7.12. V1GetActiveDBRestoreProcessResponse リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| activeStatus |