REST Resource: projects.locations.notebooks

リソース: ノートブック

ノートブックは、ユーザーがコンテンツ(ソースとして)を保存し、コンテンツを操作できるリソースです。

JSON 表現
{
  "name": string,
  "sources": [
    {
      object (Source)
    }
  ],
  "cmekConfig": {
    object (CmekConfig)
  },
  "title": string,
  "notebookId": string,
  "emoji": string,
  "metadata": {
    object (NotebookMetadata)
  }
}
フィールド
name

string

ID。ノートブックの識別子。形式: projects/{project}/locations/{location}/notebooks/{notebookId}

このフィールドは UTF-8 エンコードされた文字列にする必要があります。

sources[]

object (Source)

出力専用。ノートブック内のソースのリスト。これは出力専用のフィールドです。

cmekConfig

object (CmekConfig)

出力専用。Notebook の CMEK 関連情報。

title

string

省略可。ノートブックのタイトル。

notebookId

string

出力専用。ノートブック ID。ノートブックのリソース名の最後のセグメントです。

emoji

string

出力専用。ノートブックの絵文字。

metadata

object (NotebookMetadata)

出力専用。ノートブックのメタデータ。

NotebookMetadata

ノートブックのメタデータ。

JSON 表現
{
  "isShared": boolean,
  "isShareable": boolean,
  "lastViewed": string,
  "createTime": string
}
フィールド
isShared

boolean

このプロジェクトが現在他のユーザーと共有されている場合は true、そうでない場合は false。

isShareable

boolean

プロジェクトを共有できる場合は true。

lastViewed

string (Timestamp format)

現在のセッション中のユーザーが最後にプロジェクトを表示した時刻を示すタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

createTime

string (Timestamp format)

このプロジェクトが作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

CmekConfig

Notebooks の顧客管理の暗号化構成。

JSON 表現
{
  "kmsKey": string
}
フィールド
kmsKey

string

必須。リソース projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} の暗号化に使用される KMS 鍵のリソース名。

メソッド

batchDelete

ノートブックを一括削除します。

create

ノートブックを作成します。

get

ノートブックを取得します。

listRecentlyViewed

最後に表示した順にノートブックを一覧表示します。

share

ノートブックを他のアカウントと共有します。