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

标识符。笔记本的标识符。格式：projects/{project}/locations/{location}/notebooks/{notebookId}。

此字段必须是采用 UTF-8 编码的字符串。
sources[]

object (Source)

仅限输出。笔记本中的来源列表。此字段仅限输出。
cmekConfig

object (CmekConfig)

仅限输出。笔记本的 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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

 批量删除 Notebooks。

create

 创建笔记本。

get

 获取笔记本。

listRecentlyViewed

 列出按上次查看时间排序的笔记本。

share

 将笔记本分享给其他账号。