[Cloud Storage API(V2)] Javaで論理的削除されたオブジェクトをリストア(復元)する

Cloud Storage API V2(Java)を使用して、
Cloud Storageの論理的削除されたオブジェクトをリストア(復元)する方法
についてご紹介します。

:::note info
APIを利用する環境の準備から始める場合や、コードを実行する際は、
[⧉[Cloud Storage API(V2)] JavaでCloud Storageを使う](https://qiita.com/doran/items/2a5f7ef8070fd5b8c94d)
を参照ください。
:::

|No|||目次|
|---|---|---|---|
|1|||[オブジェクトをリストア](#1-オブジェクトをリストア)|
||1||[スコープ](#11-スコープ)|
||2||[実行](#12-実行)|
||3||[レスポンスの内容](#13-レスポンスの内容)|
|2|||[バケット内の複数オブジェクトをリストア](#2-バケット内の複数オブジェクトをリストア)|
||1||[スコープ](#21-スコープ)|
||2||[実行](#12-実行)|
||3||[レスポンスの内容](#23-レスポンスの内容)|

## 1. オブジェクトをリストア
指定した論理的削除されたオブジェクトをリストアします。

### 1.1. スコープ
このAPIを実行するには、以下のいずれかのスコープを指定してください。
```
StorageScopes.CLOUD_PLATFORM
StorageScopes.DEVSTORAGE_FULL_CONTROL
StorageScopes.DEVSTORAGE_READ_WRITE
```
[⧉[Cloud Storage API(V2)] JavaでCloud Storageを使う(2.2 Storageインスタンスを取得)](https://qiita.com/doran/items/2a5f7ef8070fd5b8c94d#22-storageインスタンスを取得)
でスコープを指定してください。

### 1.2. 実行

```java
public static void main(String[] args) throws Exception{
    Storage storage = getStorage();
    Storage.Objects objects = storage.objects();
    
    Storage.Objects.Restore restore = objects.restore(
            "バケットID",
            "オブジェクト名",
            1,//世代番号(generation),
            null);
    
    StorageObject res = restore.execute();
    System.out.println(res);
}
```
#### 1.2.1. HTTPリクエスト
POST:　https:\//storage.googleapis.com/storage/v1/b/{バケットID}/o/{オブジェクト名}/restore
が実行されます。

#### 1.2.2. クエリパラメータ
Storage.Objects.Restoreのsetメソッドにより、クエリパラメータを追加できます。

|メソッド|引数|説明|
|---|---|---|
|setCopySourceAcl|Boolean|論理的に削除されたオブジェクトのACLをコピーし、復元されたオブジェクトに適用するか|
|setIfGenerationMatch|Long|世代番号(generation)と一致する場合のみ処理を行う|
|setIfGenerationNotMatch|Long|世代番号(generation)と一致しない場合のみ処理を行う|
|setIfMetagenerationMatch|Long|メタ世代番号(metageneration)と一致する場合のみ処理を行う|
|setIfMetagenerationNotMatch|Long|メタ世代番号(metageneration)と一致しない場合のみ処理を行う|
|setProjection|String|レスポンスとして受け取るプロパティの指定<br><br>"full"(全てのプロパティ)、"noAcl"(ACL以外のプロパティ)|

#### 1.2.3. リクエストボディ
リクエストボディはありません。

### 1.3. レスポンスの内容
#### StorageObject
|メソッド|戻り値|説明|
|---|---|---|
|getId|String|オブジェクトID|	
|getKind|String|リソースの種類<br>固定文字列："storage#object"| 
|getName|String|オブジェクトの名前|
|getBucket|String|バケット名|
|getSize|BigInteger|データサイズ(バイト単位)|
|getGeneration|Long|世代番号(generation)|
|getMetageneration|Long|メタ世代番号(metageneration)|
|getEtag|String|オブジェクトのHTTPエンティティタグ|
|getMediaLink|String|オブジェクトのデータをダウンロードするためのURL|
|getSelfLink|String|オブジェクトのURL|
|getAcl|List\<[ObjectAccessControl](#objectaccesscontrol)|オブジェクトのアクセスコントロール |
|getCacheControl|String|オブジェクトデータのCache-Controlディレクティブ|
|getComponentCount|Integer|複合オブジェクトの場合の非複合オブジェクトの数|
|getContentDisposition|String|Contentオブジェクトデータの配置|
|getContentEncoding|String|Contentオブジェクトデータのエンコーディング|
|getContentLanguage|String|Contentオブジェクトデータの言語|
|getContentType|String|ContentオブジェクトデータのContent-Type|
|getCustomerEncryption|[StorageObject.CustomerEncryption](#storageobjectcustomerencryption)|顧客が指定した暗号化キーのメタデータ|	
|getEventBasedHold|Boolean|オブジェクトがイベントベースの保留の対象か|
|getKmsKeyName|String|このオブジェクトの暗号化に使用されるCloudKMS鍵|
|getMd5Hash|String|データのMD5ハッシュ値|
|getMetadata|Map\<String,String\>|ユーザーが提供するメタデータ|
|getOwner|[StorageObject.Owner](#storageobjectowner)|オブジェクトの所有者|
|getRetention|[StorageObject.Retention](#storageobjectretention)|オブジェクトの保持設定|
|getRetentionExpirationTime|DateTime|オブジェクトが削除可能なる最も早い時間|
|getSoftDeleteTime|DateTime|オブジェクトが論理的に削除された時刻|	
|getHardDeleteTime|DateTime|論理的に削除されたオブジェクトが完全に削除された時刻|
|getStorageClass|String|オブジェクトのストレージクラス|
|getTemporaryHold|Boolean|オブジェクトが 一時保留の対象か|
|getTimeCreated|DateTime|オブジェクトの作成時刻|
|getTimeDeleted|DateTime|オブジェクトの削除時刻|
|getTimeStorageClassUpdated|DateTime|オブジェクトのストレージクラスが最後に変更された時刻|
|getCustomTime|DateTime|ユーザー指定のタイムスタンプ|
|getUpdated|DateTime|オブジェクトのメタデータ変更時刻|

#### ObjectAccessControl
|メソッド|戻り値|説明|
|---|---|---|
|getKind|String|リソースの種類<br>固定文字列："storage#objectAccessControl"| 
|getDomain|String|エンティティに関連付けられているドメイン|
|getEmail|String|エンティティに関連付けられているメールアドレス|
|getEntity|String|権限を保持するエンティティ<br><br>次のいずれかの形式<br>user-{email}<br>group-{groupId}<br>group-{email}<br>domain-{domain}<br>project-{team-projectId}<br>allUsers<br>allAuthenticatedUsers|
|getEntityId|String|エンティティID|
|getEtag|String|アクセス制御エントリのHTTPエンティティタグ|
|getProjectTeam|[ObjectAccessControl.ProjectTeam](#objectaccesscontrolprojectteam)|エンティティに関連付けられているプロジェクトチーム|
|getRole|String|エンティティのアクセス許可<br>"OWNER"、"READER"、"WRITER"|

#### ObjectAccessControl.ProjectTeam
|メソッド|戻り値|説明|
|---|---|---|
|getProjectNumber|String|プロジェクト番号| 
|getTeam|String|チーム役割<br>"editors"、"owners"、"viewers"|

#### StorageObject.CustomerEncryption
|メソッド|戻り値|説明|
|---|---|---|
|getEncryptionAlgorithm|String|暗号化アルゴリズム|
|getKeySha256|String|暗号化キーの SHA256 ハッシュ値|

#### StorageObject.Owner
|メソッド|戻り値|説明|
|---|---|---|
|getEntity|String|エンティティ|
|getEntityId|String|エンティティID|

#### StorageObject.Retention
|メソッド|戻り値|説明|
|---|---|---|
|getMode|String|保持設定のモード<br>"Unlocked"(変更可)、"Locked"(変更不可)|
|getRetainUntilTime|DateTime|オブジェクトを削除または置換が可能になった時刻|

## 2. バケット内の複数オブジェクトをリストア
指定したバケット内の複数の論理的削除されたオブジェクトをリストアします。。

### 2.1. スコープ
このAPIを実行するには、以下のいずれかのスコープを指定してください。
```
StorageScopes.CLOUD_PLATFORM
StorageScopes.DEVSTORAGE_FULL_CONTROL
StorageScopes.DEVSTORAGE_READ_WRITE
```
[⧉[Cloud Storage API(V2)] JavaでCloud Storageを使う(2.2 Storageインスタンスを取得)](https://qiita.com/doran/items/2a5f7ef8070fd5b8c94d#22-storageインスタンスを取得)
でスコープを指定してください。

### 2.2. 実行

```java
public static void main(String[] args) throws Exception{
    Storage storage = getStorage();
    Storage.Objects objects = storage.objects();
    
    BulkRestoreObjectsRequest content = new BulkRestoreObjectsRequest();
    Storage.Objects.BulkRestore restore = objects.bulkRestore("バケットID",content);
    
    GoogleLongrunningOperation res = restore.execute();
    System.out.println(res);
}
```
#### 2.2.1. HTTPリクエスト
POST:　https:\//storage.googleapis.com/storage/v1/b/{バケットID}/o/bulkRestore
が実行されます。

#### 2.2.2. クエリパラメータ
クエリパラメータはありません。

#### 2.2.3. リクエストボディ
BulkRestoreObjectsRequestのsetメソッドにより、リクエストボディを追加できます。

|メソッド|引数|説明|
|---|---|---|
|setAllowOverwrite|Boolean|復元される論理的に削除されたオブジェクトと同じ名前を持つライブオブジェクトは上書きするか|
|setMatchGlob|String|Globと一致する論理的に削除されたオブジェクトのみリストア|
|setSoftDeletedAfterTime|String|指定された時間後に論理的に削除されたオブジェクトのみを復元|
|setSoftDeletedBeforeTime|String|指定された時間より前に論理的に削除されたオブジェクトのみを復元|
|setCopySourceAcl|Boolean|論理的に削除されたオブジェクトのACLをコピーし、復元されたオブジェクトに適用するか|

### 2.3. レスポンスの内容
#### GoogleLongrunningOperation
|メソッド|戻り値|説明|
|---|---|---|
|getName|String|サーバーによって割り当てられた操作の名前|
|getMetadata|Map\<String,Object\>|メタデータ|
|getDone|Boolean|操作が進行中か| 
|getError|[GoogleRpcStatus](#googlerpcstatus)|無効なパラメータまたはアクセス拒否エラー|
|getResponse|Map\<String,Object\>|詳細なエラー情報|

#### GoogleRpcStatus
|メソッド|戻り値|説明|
|---|---|---|
|getCode|Integer|HTTPステータスコード|
|getMessage|String|エラーの説明|
|getDetails|List\<Map\<String,Object\>\>|エラーの詳細|

<br>
<br>
おしまい。。