REST Resource: projects.databases

{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "cmekConfig": {
    object (CmekConfig)
  },
  "previousId": string,
  "etag": string
}

string

データベースのリソース名。形式: projects/{project}/databases/{database}

string

出力専用。このデータベースに対してシステムによって生成された UUID4。

string (Timestamp format)

出力専用。このデータベースが作成された時点のタイムスタンプ。2016 年より前に作成されたデータベースでは、createTime に値が入力されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

出力専用。このデータベースが最後に更新されたタイムスタンプ。これにはデータベース リソースの更新のみが含まれ、データベースに含まれるデータの更新は含まれないことに注意してください。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

出力専用。このデータベースが削除された時点のタイムスタンプ。データベースが削除された場合にのみ設定されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

string

データベースのロケーション。利用可能なロケーションについては、https://cloud.google.com/firestore/docs/locations をご覧ください。

enum (DatabaseType)

データベースのタイプ。選択方法については、https://cloud.google.com/datastore/docs/firestore-or-datastore をご覧ください。

enum (ConcurrencyMode)

このデータベースに使用する同時実行制御モード。

string (Duration format)

出力専用。過去のバージョンのデータがデータベースに保持される期間。

任意の read または query は、このウィンドウ内で readTime を指定でき、その時点でのデータベースの状態を読み取ります。

PITR 機能が有効な場合、保持期間は 7 日間です。それ以外の場合の保持期間は 1 時間です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

string (Timestamp format)

出力専用。古いバージョンのデータをデータベースから読み取れる最も古いタイムスタンプ。上記の [versionRetentionPeriod] をご覧ください。このフィールドには now - versionRetentionPeriod が入力されます。

この値は継続的に更新され、クエリを実行するとすぐに陳腐化します。この値を使用してデータを復元する場合、値がクエリされてから復元を行うまでの間に経過した時間を考慮する必要があります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

enum (PointInTimeRecoveryEnablement)

このデータベースで PITR 機能を有効にするかどうかを指定します。

enum (AppEngineIntegrationMode)

このデータベースに使用する App Engine 統合モード。

string

出力専用。このデータベースの keyPrefix。この keyPrefix は、Google App Engine 第 1 世代ランタイムの Cloud Datastore API から返されるアプリケーション ID を作成するために、プロジェクト ID（「~」）と組み合わせて使用されます。

この値は空でもかまいません。この場合、URL エンコードされたキーに使用する appid は projectId です（例: v~foo ではなく foo ）。

enum (DeleteProtectionState)

データベースの削除保護の状態。

object (CmekConfig)

省略可。存在する場合は、このデータベースで CMEK が有効になっていることを示します。

string

出力専用。データベース リソースの以前のデータベース ID。このフィールドは、削除されたデータベースに対してのみ入力されます。

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されて、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}

string

必須。暗号化に使用できるのは、このデータベースと同じロケーションにある鍵のみです。

Firestore の nam5 マルチリージョンの場合、これは Cloud KMS マルチリージョンの us に対応します。Firestore の eur3 マルチリージョンの場合、これは Cloud KMS マルチリージョン（ヨーロッパ）に対応します。https://cloud.google.com/kms/docs/locations をご覧ください。

想定される形式は projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} です。

string

出力専用。現在使用中の KMS 鍵バージョン。鍵のローテーション中は、複数の使用中の鍵バージョンが存在する可能性があります。

想定される形式は projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} です。