PutMetadata

オブジェクトのメタデータ更新に関するオプションについて説明します。

JSON 表現
{
  "customMetadata": {
    string: string,
    ...
  },
  "contentDisposition": string,
  "contentEncoding": string,
  "contentLanguage": string,
  "contentType": string,
  "cacheControl": string,
  "customTime": string,
  "objectRetention": {
    object (ObjectRetention)
  }
}
フィールド
customMetadata

map (key: string, value: string)

省略可。オブジェクトのカスタム メタデータを更新します。このオペレーションは、個々のカスタム メタデータの Key-Value ペアを追加または設定します。空の値で指定されたキーの値はクリアされます。リクエストに含まれていない既存のカスタム メタデータキーは変更されません。詳細については、カスタムメタデータを参照してください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

contentDisposition

string

省略可。オブジェクトの Content-Disposition 固定メタデータを更新します。リクエストで設定されていない値は無視されます。メタデータをクリアするには、空の値を設定します。詳しくは、Content-Disposition をご覧ください。

contentEncoding

string

省略可。オブジェクトの Content-Encoding 固定メタデータを更新します。リクエストで設定されていない値は無視されます。メタデータをクリアするには、空の値を設定します。詳しくは、Content-Encoding をご覧ください。

contentLanguage

string

省略可。オブジェクトの Content-Language 固定メタデータを更新します。メタデータ値には ISO 639-1 言語コードを使用する必要があります。メタデータ値の最大長は 100 文字です。リクエストで設定されていない値は無視されます。メタデータをクリアするには、空の値を設定します。詳しくは、Content-Language をご覧ください。

contentType

string

省略可。オブジェクトの Content-Type 固定メタデータを更新します。リクエストで設定されていない値は無視されます。メタデータをクリアするには、空の値を設定します。詳しくは、Content-Type をご覧ください。

cacheControl

string

省略可。オブジェクトの Cache-Control 固定メタデータを更新します。リクエストで設定されていない値は無視されます。メタデータをクリアするには、空の値を設定します。また、Custom-Time の値を小さくすることはできません。詳しくは、Cache-Control をご覧ください。

customTime

string

省略可。オブジェクトの Custom-Time 固定メタデータを更新します。リクエストで設定されていない値は無視されます。メタデータをクリアするには、空の値を設定します。時間は RFC 3339 形式で指定する必要があります(例: YYYY-MM-DD'T'HH:MM:SS'Z'YYYY-MM-DD'T'HH:MM:SS.SS'Z')。詳細については、Custom-Time をご覧ください。

objectRetention

object (ObjectRetention)

省略可。オブジェクトの保持構成を更新します。オブジェクトの保持を解除するには、retentionModeretainUntilTime の両方を設定しない(省略する)必要があります。retentionModeRETENTION_MODE_UNSPECIFIEDに設定しても、何もしない操作として扱われます。未設定のフィールドとは異なり、保持設定は変更もクリアもされません。保持モードが LOCKED のオブジェクトは、保持をクリアしたり、retainUntilTime を減らしたりすることはできません。詳細については、オブジェクト保持を参照してください。

ObjectRetention

オブジェクト保持期間の更新に関するオプションについて説明します。

JSON 表現
{
  "retainUntilTime": string,
  "retentionMode": enum (RetentionMode)
}
フィールド
retainUntilTime

string

必須。オブジェクトの保持の有効期間。この期間中は、オブジェクトは削除または上書きされないように保護されます。時間は RFC 3339 形式で指定する必要があります(例: YYYY-MM-DD'T'HH:MM:SS'Z'YYYY-MM-DD'T'HH:MM:SS.SS'Z')。オブジェクトの保持を解除するには、retentionModeretainUntilTime の両方を設定しない(省略する)必要があります。retentionModeRETENTION_MODE_UNSPECIFIEDに設定しても、何もしない操作として扱われます。未設定のフィールドとは異なり、保持設定は変更もクリアもされません。

retentionMode

enum (RetentionMode)

必須。保持モード。

RetentionMode

保持モード。

列挙型
RETENTION_MODE_UNSPECIFIED 保持モードは指定されていません。
LOCKED 保持モードがLOCKEDの場合、retainUntilTimeは削除または削減できません。
UNLOCKED 保持モードが UNLOCKED の場合は、retainUntilTime を削除または変更できます。