[Cloud Storage API(V2)] JavaでCloud Storage上のオフジェクトを結合する

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-レスポンスの内容)|

## 1. オブジェクトを結合
Cloud Storage上のオブジェクトを結合します。

一度に結合できるオブジェクトの数は最大32個までです。
結合できるオブジェクトは同じバケット内のオブジェクトのみです。

### 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();
    
    ComposeRequest content = new ComposeRequest();
    List<ComposeRequest.SourceObjects> list = new ArrayList<>();
    list.add(new ComposeRequest.SourceObjects().setName("結合するオブジェクト名"));
    list.add(new ComposeRequest.SourceObjects().setName("結合するオブジェクト名"));
    content.setSourceObjects(list);
    
    Storage.Objects.Compose compose = objects.compose("バケットID","結合後のオブジェクト名", content);
    
    StorageObject res = compose.execute();
    System.out.println(res);
}
```
#### 1.2.1. HTTPリクエスト
POST:　https:\//storage.googleapis.com/storage/v1/b/{バケットID}/o/{結合後のオブジェクト名}/compose
が実行されます。

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

|メソッド|引数|説明|
|---|---|---|
|setIfGenerationMatch|Long|世代番号(generation)|
|setIfMetagenerationMatch|Long|メタ世代番号(metageneration)|
|setDestinationPredefinedAcl|String|結合されたオブジェクトに定義する[アクセス制御リスト(ACL)の定義](#アクセス制御リストaclの定義)|
|setKmsKeyName|String|結合されたオブジェクトの暗号化に使用されるCloud KMS 鍵のリソース名|

#### アクセス制御リスト(ACL)の定義
|定義値|内容|
|---|---|
|authenticatedRead|オブジェクト所有者がOWNERアクセス権を取得し、アクセス権allAuthenticatedUsersを取得|
|bucketOwnerFullControl|オブジェクトとプロジェクトチームの所有者がOWNERアクセス権を取得|
|bucketOwnerRead|オブジェクトの所有者がOWNERアクセス権を取得し、プロジェクトチームの所有者がREADERアクセス権を取得|
|private|オブジェクト所有者がOWNERアクセス権を取得|
|projectPrivate|オブジェクト所有者はOWNERアクセス権を取得し、プロジェクトチームのメンバーはそれぞれの役割に応じてアクセス権を取得|
|publicRead|オブジェクト所有者がOWNERアクセス権を取得し、 アクセス権allUsersを取得|

#### 1.2.3. リクエストボディ
ComposeRequestのsetメソッドにより、クエリパラメータを追加できます。

|メソッド|引数|説明|
|---|---|---|
|setDestination|[StorageObject](#storageobjectset)|結合されたオブジェクトのプロパティ|
|setSourceObjects|List\<[ComposeRequest.SourceObjects](#composerequestsourceobjects)\>|単一のオブジェクトに連結されるソースオブジェクトのリスト<br>最大32個まで|

#### StorageObject(Set)
|メソッド|引数|説明|
|---|---|---|
|setName|String|オブジェクトの名前|
|setAcl|List\<[ObjectAccessControl](#objectaccesscontrolset)|オブジェクトのアクセスコントロール |
|setContentDisposition|String|Contentオブジェクトデータの配置|
|setContentEncoding|String|Contentオブジェクトデータのエンコーディング|
|setContentLanguage|String|Contentオブジェクトデータの言語|
|setContentType|String|ContentオブジェクトデータのContent-Type|
|setEventBasedHold|Boolean|オブジェクトがイベントベースの保留の対象か|
|setMd5Hash|String|データのMD5ハッシュ値|
|setMetadata|Map\<String,String\>|ユーザーが提供するメタデータ|
|setRetention|[StorageObject.Retention](#storageobjectretentionset)|オブジェクトの保持設定|
|setStorageClass|String|オブジェクトのストレージクラス|
|setTemporaryHold|Boolean|オブジェクトが 一時保留の対象か|
|setCustomTime|DateTime|ユーザー指定のタイムスタンプ|
|setCrc32c|String|CRC32c チェックサム|

#### ObjectAccessControl(Set)
|メソッド|引数|説明|
|---|---|---|
|setEntity|String|権限を保持するエンティティ<br><br>次のいずれかの形式<br>user-{email}<br>group-{groupId}<br>group-{email}<br>domain-{domain}<br>project-{team-projectId}<br>allUsers<br>allAuthenticatedUsers|
|setRole|String|エンティティのアクセス許可<br>"OWNER"、"READER"、"WRITER"|

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

#### ComposeRequest.SourceObjects
|メソッド|引数|説明|
|---|---|---|
|setName|String|ソースオブジェクトの名前|
|setGeneration|Long|世代番号(generation)|
|setObjectPreconditions|[ComposeRequest.SourceObjects.ObjectPreconditions](#composerequestsourceobjectsobjectpreconditions)|実行するための必要な条件|

#### ComposeRequest.SourceObjects.ObjectPreconditions
|メソッド|引数|説明|
|---|---|---|
|setIfGenerationMatch|Long|オブジェクトの世代番号(generation)が一致する場合のみ操作を実行|

### 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|オブジェクトを削除または置換が可能になった時刻|

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