File: discoveryengine_v1alpha.projects.locations.notebooks.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (149 lines) | stat: -rw-r--r-- 5,409 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.notebooks.html">notebooks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="discoveryengine_v1alpha.projects.locations.notebooks.sources.html">sources()</a></code>
</p>
<p class="firstline">Returns the sources Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#listRecentlyViewed">listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the recently viewed notebooks. Needs a side channel with the user's EUC.</p>
<p class="toc_element">
  <code><a href="#listRecentlyViewed_next">listRecentlyViewed_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="listRecentlyViewed">listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the recently viewed notebooks. Needs a side channel with the user&#x27;s EUC.

Args:
  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
  pageSize: integer, Optional. Maximum number of Notebooks to return. If unspecified, defaults to &quot;200&quot;. The maximum allowed value is &quot;500&quot;. If this field is negative, will use the default value.
  pageToken: string, Optional. The page token, provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for NotebookService.ListRecentlyViewedNotebooks method.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token, provide this to retrieve the subsequent page.
  &quot;notebooks&quot;: [ # The list of recently viewed notebooks.
    { # Notebook is a resource where users can store their content (as sources) and interacts with the content.
      &quot;cmekConfig&quot;: { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
        &quot;kmsKey&quot;: &quot;A String&quot;, # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
      },
      &quot;emoji&quot;: &quot;A String&quot;, # Output only. The emoji of the notebook.
      &quot;metadata&quot;: { # Metadata for a notebook. # The metadata of the notebook.
        &quot;createTime&quot;: &quot;A String&quot;, # The time at which this project was created.
        &quot;isShareable&quot;: True or False, # True if the project is shareable.
        &quot;isShared&quot;: True or False, # True if this project is currently shared with other people, false otherwise.
        &quot;lastViewed&quot;: &quot;A String&quot;, # A timestamp indicating the time that the current in session user has last viewed the project.
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
      &quot;notebookId&quot;: &quot;A String&quot;, # Optional. Notebook id, which is the last segment of the notebook&#x27;s resource name. This is to make it similar with notebooklm API.
      &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the notebook.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="listRecentlyViewed_next">listRecentlyViewed_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>