Console
    Contact Us Start free

    REST Resource: projects.locations.notebooks

    Resource: Notebook

    Notebook is a resource where users can store their content (as sources) and interacts with the content.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "sources" 
 : 
 [ 
 { 
 object (  Source 
 
) 
 } 
 ] 
 , 
 "cmekConfig" 
 : 
 { 
 object (  CmekConfig 
 
) 
 } 
 , 
 "title" 
 : 
 string 
 , 
 "notebookId" 
 : 
 string 
 , 
 "emoji" 
 : 
 string 
 , 
 "metadata" 
 : 
 { 
 object (  NotebookMetadata 
 
) 
 } 
 }
    Fields
    name

    string

    Identifier. The identifier of the notebook. Format: projects/{project}/locations/{location}/notebooks/{notebookId} .

    This field must be a UTF-8 encoded string.
    sources[]

    object ( Source )

    Output only. List of sources in the notebook. This is an output only field.
    cmekConfig

    object ( CmekConfig )

    Output only. CMEK-related information for the Notebook.
    title

    string

    Optional. The title of the notebook.
    notebookId

    string

    Output only. Notebook id, which is the last segment of the notebook's resource name.
    emoji

    string

    Output only. The emoji of the notebook.
    metadata

    object ( NotebookMetadata )

    Output only. The metadata of the notebook.

    NotebookMetadata

    metadata for a notebook.

    JSON representation 
     { 
 "isShared" 
 : 
 boolean 
 , 
 "isShareable" 
 : 
 boolean 
 , 
 "lastViewed" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 }
    Fields
    isShared

    boolean

    True if this project is currently shared with other people, false otherwise.
    isShareable

    boolean

    True if the project is shareable.
    lastViewed

    string ( Timestamp format)

    A timestamp indicating the time that the current in session user has last viewed the project.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    createTime

    string ( Timestamp format)

    The time at which this project was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    CmekConfig

    Customer-managed encryption configuration for Notebooks.

    JSON representation 
     { 
 "kmsKey" 
 : 
 string 
 }
    Fields
    kmsKey

    string

    Required. KMS key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} .

    Methods

    batchDelete

    		Batch deletes Notebooks.

    create

    		Creates a notebook.

    get

    		Gets a notebook.

    listRecentlyViewed

    		Lists the notebooks ordered by last view time.
    Shares a notebook to other accounts.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: