ObjectMetadata (iijgio-dag-client-all 1.2.4 API)

java.lang.Object
- com.iijgio.dag.services.storage.model.ObjectMetadata

All Implemented Interfaces:

ObjectExpirationResult, ServerSideEncryptionResult
```
public class ObjectMetadata
extends Object
implements ServerSideEncryptionResult, ObjectExpirationResult
```
IIJ GIOストレージ＆アナリシスサービスのオブジェクトメタデータを定義しますこのクラスにはユーザが提供するカスタムのメタデータや、送受信したHTTPヘッダ (Content-Length, ETag, Content-MD5等)を含みます
TODO Amazon Glacierに相当するサービスを追加した場合は、 ObjectRestoreResultインターフェイスを実装すること。

Field Summary

Fields
Modifier and Type Field and Description

static String AES_256_SERVER_SIDE_ENCRYPTION

Fields
Modifier and Type	Field and Description
`static String`	`AES_256_SERVER_SIDE_ENCRYPTION`

Constructor Summary

Constructors
Constructor and Description

ObjectMetadata()

Constructors
Constructor and Description
`ObjectMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addUserMetadata(String key, String value)` オブジェクトに関連したカスタムユーザメタデータのキー・バリューペアを追加します。既にカスタムユーザメタデータのエントリが存在していた場合、新たに置き換えられます
`String`	`getCacheControl()` HTTPリクエスト・応答のキャッシュに関する挙動を指定するHTTP Cache-Control ヘッダを返します。
`String`	`getContentDisposition()` オブジェクトをセーブすべきファイル名などの情報を定義する、オプションヘッダである HTTP Content-Disposition ヘッダを返します
`String`	`getContentEncoding()` どのcontent encoding がオブジェクトに適用され、Content-Typeフィールドで指定されたmime typeよるデコードメカニズムが適用されたかを示すオプションのHTTPヘッダであるContent-Encodingヘッダを返します。
`long`	`getContentLength()` オブジェクトのサイズ(バイト数)を表すContent-Lengthヘッダの値を返します。
`String`	`getContentMD5()` オブジェクトの、RFC1864形式の base64エンコードされた128bit MD5ダイジェスト (コンテンツのみ。ヘッダは含まない)を返します。このデータは送信されたデータの同一性の確認に使用されます
`String`	`getContentType()` オブジェクトとして保管されているコンテンツのデータタイプを示す、 HTTP Conetent-Typeヘッダの値を返します。このヘッダの値は標準MIME typeになります。
`String`	`getETag()` RFC1864形式のオブジェクトのHexエンコードされた128bit MD5ダイジェストを返します。このデータはデータ受信の際の完全性の検証に使われます。
`Date`	`getExpirationTime()` このオブジェクトが有効期限切れになりIIJ GIOストレージ＆アナリシスサービスから完全に削除される時間を返します。有効期限切れにならない場合、nullを返します。
`String`	`getExpirationTimeRuleId()` このオブジェクトの有効期限切れに関する`BucketLifecycleConfiguration`のルールIDを返します。有効期限切れでなければ、nullを返します。
`Date`	`getHttpExpiresDate()` オブジェクトがこれ以上キャッシュすることができなくなる日時を返します。
`Date`	`getLastModified()` オブジェクトに関連したLast-Modifiedヘッダの値を返します。これは、オブジェクトの最終更新日時を表します。
`Map<String,Object>`	`getRawMetadata()` 内部利用のみオブジェクトに関連した生のメタデータ/ヘッダを返します。
`String`	`getServerSideEncryption()` このオブジェクトのサーバ側の暗号化アルゴリズムを返します。何も使用されていなければ、nullになります。
`Map<String,String>`	`getUserMetadata()` このオブジェクトに関連したカスタムユーザメタデータを返します
`String`	`getVersionId()` IIJ GIOストレージ＆アナリシスサービスではバージョニングは現在対応していません。有効な場合にオブジェクトに関連したバージョンIDを返します。バージョンIDはバケットのバージョニングが有効にされている場合にのみ割り当てられます
`void`	`setCacheControl(String cacheControl)` HTTPリクエスト・応答のキャッシュに関する挙動を指定するHTTP Cache-Control ヘッダをセットします。
`void`	`setContentDisposition(String disposition)` オブジェクトをセーブすべきファイル名などの情報を定義する、オプションヘッダである HTTP Content-Disposition ヘッダをセットします
`void`	`setContentEncoding(String encoding)` どのcontent encoding がオブジェクトに適用され、Content-Typeフィールドで指定されたmime typeよるデコードメカニズムが適用されたかを示すオプションのHTTPヘッダであるContent-Encodingヘッダをセットします。
`void`	`setContentLength(long contentLength)` オブジェクトのサイズ(バイト数)を表すContent-Lengthヘッダの値をセットします。
`void`	`setContentMD5(String md5Base64)` オブジェクトの、RFC1864形式の base64エンコードされた128bit MD5ダイジェスト (コンテンツのみ。ヘッダは含まない)をセットします。このデータは送信されたデータの同一性の確認に使用されます
`void`	`setContentType(String contentType)` オブジェクトとして保管されているコンテンツのデータタイプを示す、 HTTP Conetent-Typeヘッダの値をセットします。
`void`	`setExpirationTime(Date expirationTime)` 内部でのみ使用されます。これはオブジェクトの有効期限切れ時間をセットしません。 IIJ GIOストレージ＆アナリシスサービスからのレスポンス内の値を受け取った後、オブジェクトに値をセットするために使われます。
`void`	`setExpirationTimeRuleId(String expirationTimeRuleId)` このオブジェクトの有効期限切れに関する`BucketLifecycleConfiguration`のルールIDをセットします。
`void`	`setHeader(String key, Object value)` SDK内部利用のみメタデータヘッダにキーと値をセットします。 SDK外部からの呼び出しは想定していません。
`void`	`setHttpExpiresDate(Date httpExpiresDate)` オブジェクトがこれ以上キャッシュすることができなくなる日時をセットします。
`void`	`setLastModified(Date lastModified)` SDK内部利用のみオブジェクトに関連したLast-Modifiedヘッダの値をセットします。これは、オブジェクトの最終更新日時を表します。
`void`	`setServerSideEncryption(String serverSideEncryption)` このオブジェクトのサーバ側の暗号化アルゴリズムをセットします。
`void`	`setUserMetadata(Map<String,String> userMetadata)` このオブジェクトに関連したカスタムユーザメタデータをセットします

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AES_256_SERVER_SIDE_ENCRYPTION
```
public static final String AES_256_SERVER_SIDE_ENCRYPTION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ObjectMetadata
```
public ObjectMetadata()
```
- Method Detail
  - getUserMetadata
```
public Map<String,String> getUserMetadata()
```
    このオブジェクトに関連したカスタムユーザメタデータを返します
    
    IIJ GIOストレージ＆アナリシスサービスではオブジェクトに追加のメタデータを関連付けることができます。これはHTTPヘッダに 'x-iijgio-meta-'というプレフィックスで定義した追加ヘッダによって指定されます。ユーザメタデータはオブジェクトに関連させたい情報を保管する事ができます。ユーザメタデータを使用する場合、ライブラリ内部でハンドルされるため、 SDK利用者はHTTPヘッダとして'x-iijgio-meta-'を直接指定するべきではありません。同様にSDK利用者がユーザメタデータを読み出す場合は、"x-iijgio-meta-"ヘッダより参照することはできません。
    
    注意: オブジェクトのユーザメタデータは、HTTPリクエストヘッダの制限が適用されますリクエスト中の全てのHTTPヘッダ(ユーザメタデータを含む)は8KB以下である必要があります。
    
    Returns:
    
    オブジェクトに関連したカスタムユーザメタデータ
    
    See Also:
    
    setUserMetadata(Map), addUserMetadata(String, String)
  - setUserMetadata
```
public void setUserMetadata(Map<String,String> userMetadata)
```
    このオブジェクトに関連したカスタムユーザメタデータをセットします
    
    IIJ GIOストレージ＆アナリシスサービスではオブジェクトに追加のメタデータを関連付けることができます。これはHTTPヘッダに 'x-iijgio-meta-'というプレフィックスで定義した追加ヘッダによって指定されます。ユーザメタデータはオブジェクトに関連させたい情報を保管する事ができます。ユーザメタデータを使用する場合、ライブラリ内部でハンドルされるため、 SDK利用者はHTTPヘッダとして'x-iijgio-meta-'を直接指定するべきではありません。同様にSDK利用者がユーザメタデータを読み出す場合は、"x-iijgio-meta-"ヘッダより参照することはできません。
    
    注意: オブジェクトのユーザメタデータは、HTTPリクエストヘッダの制限が適用されますリクエスト中の全てのHTTPヘッダ(ユーザメタデータを含む)は8KB以下である必要があります。
    
    Parameters:
    
    userMetadata - オブジェクトに関連したカスタムユーザメタデータ
    
    See Also:
    
    getUserMetadata(), addUserMetadata(String, String)
  - setHeader
```
public void setHeader(String key,
                      Object value)
```
    SDK内部利用のみメタデータヘッダにキーと値をセットします。 SDK外部からの呼び出しは想定していません。
    
    Parameters:
    
    key - セットするヘッダの名前
    
    value - セットするヘッダの値
  - addUserMetadata
```
public void addUserMetadata(String key,
                            String value)
```
    オブジェクトに関連したカスタムユーザメタデータのキー・バリューペアを追加します。既にカスタムユーザメタデータのエントリが存在していた場合、新たに置き換えられます
    
    IIJ GIOストレージ＆アナリシスサービスではオブジェクトに追加のメタデータを関連付けることができます。これはHTTPヘッダに 'x-iijgio-meta-'というプレフィックスで定義した追加ヘッダによって指定されます。ユーザメタデータはオブジェクトに関連させたい情報を保管する事ができます。ユーザメタデータを使用する場合、ライブラリ内部でハンドルされるため、 SDK利用者はHTTPヘッダとして'x-iijgio-meta-'を直接指定するべきではありません。同様にSDK利用者がユーザメタデータを読み出す場合は、"x-iijgio-meta-"ヘッダより参照することはできません。
    
    注意: オブジェクトのユーザメタデータは、HTTPリクエストヘッダの制限が適用されますリクエスト中の全てのHTTPヘッダ(ユーザメタデータを含む)は8KB以下である必要があります。
    
    Parameters:
    
    key - カスタムユーザメタデータエントリのキー
    
    value - カスタムユーザメタデータエントリの値
    
    See Also:
    
    setUserMetadata(Map), getUserMetadata()
  - getRawMetadata
```
public Map<String,Object> getRawMetadata()
```
    内部利用のみオブジェクトに関連した生のメタデータ/ヘッダを返します。
    
    Returns:
    
    オブジェクトに関連した生のメタデータ/ヘッダのマップ
  - getLastModified
```
public Date getLastModified()
```
    オブジェクトに関連したLast-Modifiedヘッダの値を返します。これは、オブジェクトの最終更新日時を表します。
    
    Returns:
    
    オブジェクトに関連したLast-Modifiedヘッダの値 Last-Modified ヘッダが無かった場合はnull
  - setLastModified
```
public void setLastModified(Date lastModified)
```
    SDK内部利用のみオブジェクトに関連したLast-Modifiedヘッダの値をセットします。これは、オブジェクトの最終更新日時を表します。
    
    Parameters:
    
    lastModified - オブジェクトの最終更新日時
  - getContentLength
```
public long getContentLength()
```
    オブジェクトのサイズ(バイト数)を表すContent-Lengthヘッダの値を返します。
    
    このフィールドはアップロードの際に必須ですが、SDKクライアントはファイルから読み込む場合は自動的に取得しセットします。ストリームから直接アップロードする場合は、可能であればセットしてください。さもなければ、クライアントはContentLengthを計算するために、データの送信前にストリームを全てバッファしなければなりません。
    
    Returns:
    
    オブジェクトのサイズ(バイト数)を表すContent-Lengthヘッダの値
    
    See Also:
    
    setContentLength(long)
  - setContentLength
```
public void setContentLength(long contentLength)
```
    オブジェクトのサイズ(バイト数)を表すContent-Lengthヘッダの値をセットします。
    
    このフィールドはアップロードの際に必須ですが、SDKクライアントはファイルから読み込む場合は自動的に取得しセットします。ストリームから直接アップロードする場合は、可能であればセットしてください。さもなければ、クライアントはContentLengthを計算するために、データの送信前にストリームを全てバッファしなければなりません。
    
    Parameters:
    
    contentLength - オブジェクトのサイズ(バイト数)を表すContent-Lengthヘッダの値
    
    See Also:
    
    getContentLength()
  - getContentType
```
public String getContentType()
```
    オブジェクトとして保管されているコンテンツのデータタイプを示す、 HTTP Conetent-Typeヘッダの値を返します。このヘッダの値は標準MIME typeになります。
    
    ファイルをアップロードする際、SDKクライアントはContent typeがセットされていなかった場合、正しいContent typeを判別しようとします。ユーザは正しいContent typeをストリームのアップロード時にセットしなければなりません。もし、Content-typeが指定されていなかったおらず、ファイル名から判別出来なかった場合は、デフォルトのContent typeである "application/octet-stream"が使われます
    
    Returns:
    
    オブジェクトとして保管されているコンテンツのデータタイプを示す、 HTTP Conetent-Typeヘッダの値
    
    See Also:
    
    setContentType(String)
  - setContentType
```
public void setContentType(String contentType)
```
    オブジェクトとして保管されているコンテンツのデータタイプを示す、 HTTP Conetent-Typeヘッダの値をセットします。
    このヘッダの値は標準MIME typeになります。
    
    ファイルをアップロードする際、SDKクライアントはContent typeがセットされていなかった場合、正しいContent typeを判別しようとします。
    ユーザは正しいContent typeをストリームのアップロード時にセットしなければなりません。もし、Content-typeが指定されていなかったおらず、ファイル名から判別出来なかった場合は、デフォルトのContent typeである "application/octet-stream"が使われます
    
    Parameters:
    
    contentType - オブジェクトとして保管されているコンテンツのデータタイプを示す、 HTTP Conetent-Typeヘッダの値
    
    See Also:
    
    getContentType()
  - getContentEncoding
```
public String getContentEncoding()
```
    どのcontent encoding がオブジェクトに適用され、Content-Typeフィールドで指定されたmime typeよるデコードメカニズムが適用されたかを示すオプションのHTTPヘッダであるContent-Encodingヘッダを返します。
    
    Returns:
    
    RFC2616で定義された HTTP Content-Encoding ヘッダヘッダがセットされていない場合は null
    
    See Also:
    
    setContentType(String)
  - setContentEncoding
```
public void setContentEncoding(String encoding)
```
    どのcontent encoding がオブジェクトに適用され、Content-Typeフィールドで指定されたmime typeよるデコードメカニズムが適用されたかを示すオプションのHTTPヘッダであるContent-Encodingヘッダをセットします。
    
    Parameters:
    
    encoding - RFC2616で定義された HTTP Content-Encoding ヘッダ
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11, getContentType()
  - getCacheControl
```
public String getCacheControl()
```
    HTTPリクエスト・応答のキャッシュに関する挙動を指定するHTTP Cache-Control ヘッダを返します。
    
    Returns:
    
    RFC 2616で定義された HTTP Cache-Control ヘッダセットされていない場合は null
    
    See Also:
    
    setCacheControl(String)
  - setCacheControl
```
public void setCacheControl(String cacheControl)
```
    HTTPリクエスト・応答のキャッシュに関する挙動を指定するHTTP Cache-Control ヘッダをセットします。
    
    Parameters:
    
    cacheControl - RFC 2616で定義された HTTP Cache-Control ヘッダセットされていない場合は null
    
    See Also:
    
    getCacheControl()
  - getContentMD5
```
public String getContentMD5()
```
    オブジェクトの、RFC1864形式の base64エンコードされた128bit MD5ダイジェスト (コンテンツのみ。ヘッダは含まない)を返します。このデータは送信されたデータの同一性の確認に使用されます
    
    このフォールドは、オブジェクトのBASE64エンコードされた128bit MD5ダイジェストを呼び出し側で計算します。ETagメタデータはHexエンコードされた128bit MD5ダイジェストをサービスAPI側で計算します。
    
    SDKクライアントはアップロードの際に自動的にこのフィールド値を計算します
    
    Returns:
    
    オブジェクトの、RFC1864形式の base64エンコードされた128bit MD5ダイジェストセットされていない場合は null
    
    See Also:
    
    setContentMD5(String)
  - setContentMD5
```
public void setContentMD5(String md5Base64)
```
    オブジェクトの、RFC1864形式の base64エンコードされた128bit MD5ダイジェスト (コンテンツのみ。ヘッダは含まない)をセットします。このデータは送信されたデータの同一性の確認に使用されます
    
    このフォールドは、オブジェクトのBASE64エンコードされた128bit MD5ダイジェストを呼び出し側で計算します。ETagメタデータはHexエンコードされた128bit MD5ダイジェストをサービスAPI側で計算します。
    
    SDKクライアントはアップロードの際に自動的にこのフィールド値を計算します
    
    Parameters:
    
    md5Base64 - オブジェクトの、RFC1864形式の base64エンコードされた128bit MD5ダイジェスト
    
    See Also:
    
    getContentMD5()
  - getContentDisposition
```
public String getContentDisposition()
```
    オブジェクトをセーブすべきファイル名などの情報を定義する、オプションヘッダである HTTP Content-Disposition ヘッダを返します
    
    Returns:
    
    HTTP Content-Disposition ヘッダの値セットされていない場合は null
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1, setCacheControl(String)
  - setContentDisposition
```
public void setContentDisposition(String disposition)
```
    オブジェクトをセーブすべきファイル名などの情報を定義する、オプションヘッダである HTTP Content-Disposition ヘッダをセットします
    
    Parameters:
    
    disposition - HTTP Content-Disposition ヘッダの値
    
    See Also:
    
    getContentDisposition()
  - getETag
```
public String getETag()
```
    RFC1864形式のオブジェクトのHexエンコードされた128bit MD5ダイジェストを返します。このデータはデータ受信の際の完全性の検証に使われます。
    このフォールドは、Hexエンコードされた128bit MD5ダイジェストをサービスAPI側で計算しますが、ContentMD5フィールドにはオブジェクトのBASE64エンコードされた 128bit MD5ダイジェストを呼び出し側で計算します。
    
    Returns:
    
    RFC1864形式のオブジェクトのHexエンコードされた128bit MD5ダイジェストセットされていない場合は null
  - getVersionId
```
public String getVersionId()
```
    IIJ GIOストレージ＆アナリシスサービスではバージョニングは現在対応していません。有効な場合にオブジェクトに関連したバージョンIDを返します。バージョンIDはバケットのバージョニングが有効にされている場合にのみ割り当てられます
    
    Returns:
    
    有効な場合、オブジェクトに関連したバージョンID
  - getServerSideEncryption
```
public String getServerSideEncryption()
```
    このオブジェクトのサーバ側の暗号化アルゴリズムを返します。何も使用されていなければ、nullになります。
    
    Specified by:
    
    getServerSideEncryption in interface ServerSideEncryptionResult
    
    Returns:
    
    サーバ側の暗号化アルゴリズム
  - setServerSideEncryption
```
public void setServerSideEncryption(String serverSideEncryption)
```
    このオブジェクトのサーバ側の暗号化アルゴリズムをセットします。
    
    Specified by:
    
    setServerSideEncryption in interface ServerSideEncryptionResult
    
    Parameters:
    
    serverSideEncryption - このオブジェクトのサーバ側の暗号化アルゴリズム
  - getExpirationTime
```
public Date getExpirationTime()
```
    このオブジェクトが有効期限切れになりIIJ GIOストレージ＆アナリシスサービスから完全に削除される時間を返します。有効期限切れにならない場合、nullを返します。
    
    Specified by:
    
    getExpirationTime in interface ObjectExpirationResult
    
    Returns:
    
    有効期限切れの日時
  - setExpirationTime
```
public void setExpirationTime(Date expirationTime)
```
    内部でのみ使用されます。これはオブジェクトの有効期限切れ時間をセットしません。 IIJ GIOストレージ＆アナリシスサービスからのレスポンス内の値を受け取った後、オブジェクトに値をセットするために使われます。
    
    Specified by:
    
    setExpirationTime in interface ObjectExpirationResult
    
    Parameters:
    
    expirationTime - このオブジェクトが有効期限切れ時間
  - getExpirationTimeRuleId
```
public String getExpirationTimeRuleId()
```
    このオブジェクトの有効期限切れに関するBucketLifecycleConfigurationのルールIDを返します。有効期限切れでなければ、nullを返します。
    
    Specified by:
    
    getExpirationTimeRuleId in interface ObjectExpirationResult
    
    Returns:
    
    バケットライフサイクル設定のRule ID
    
    See Also:
    
    BucketLifecycleConfiguration.Rule.getId()
  - setExpirationTimeRuleId
```
public void setExpirationTimeRuleId(String expirationTimeRuleId)
```
    このオブジェクトの有効期限切れに関するBucketLifecycleConfigurationのルールIDをセットします。
    
    Specified by:
    
    setExpirationTimeRuleId in interface ObjectExpirationResult
    
    Parameters:
    
    expirationTimeRuleId - このオブジェクトの有効期限切れに関するのルールID
  - getHttpExpiresDate
```
public Date getHttpExpiresDate()
```
    オブジェクトがこれ以上キャッシュすることができなくなる日時を返します。
    
    Returns:
    
    オブジェクトがこれ以上キャッシュすることができなくなる日時
  - setHttpExpiresDate
```
public void setHttpExpiresDate(Date httpExpiresDate)
```
    オブジェクトがこれ以上キャッシュすることができなくなる日時をセットします。
    
    Parameters:
    
    httpExpiresDate - オブジェクトがこれ以上キャッシュすることができなくなる日時

Class ObjectMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AES_256_SERVER_SIDE_ENCRYPTION

Constructor Detail

ObjectMetadata

Method Detail

getUserMetadata

setUserMetadata

setHeader

addUserMetadata

getRawMetadata

getLastModified

setLastModified

getContentLength

setContentLength

getContentType

setContentType

getContentEncoding

setContentEncoding

getCacheControl

setCacheControl

getContentMD5

setContentMD5

getContentDisposition

setContentDisposition

getETag

getVersionId

getServerSideEncryption

setServerSideEncryption

getExpirationTime

setExpirationTime

getExpirationTimeRuleId

setExpirationTimeRuleId

getHttpExpiresDate

setHttpExpiresDate