docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html

<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.audioOverviews.html">audioOverviews()</a></code>
</p>
<p class="firstline">Returns the audioOverviews Resource.</p>

<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="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch deletes Notebooks.</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a notebook.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a notebook.</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 notebooks ordered by last view time.</p>
<p class="toc_element">
  <code><a href="#listRecentlyViewed_next">listRecentlyViewed_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#share">share(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Shares a notebook to other accounts.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
  <pre>Batch deletes Notebooks.

Args:
  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for NotebookService.BatchDeleteNotebooks method.
  &quot;names&quot;: [ # Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a notebook.

Args:
  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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. # Output only. 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;, # Output only. Notebook id, which is the last segment of the notebook&#x27;s resource name.
  &quot;sources&quot;: [ # Output only. List of sources in the notebook. This is an output only field.
    { # Source represents a single source of content.
      &quot;metadata&quot;: { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
        &quot;agentspaceMetadata&quot;: { # Metadata about an agentspace source. # Metadata for an agentspace source.
          &quot;documentName&quot;: &quot;A String&quot;, # Output only. The full document name in Agentspace.
          &quot;documentTitle&quot;: &quot;A String&quot;, # Output only. The title of the document.
        },
        &quot;googleDocsMetadata&quot;: { # Metadata about a google doc source. # Metadata for a google doc source.
          &quot;documentId&quot;: &quot;A String&quot;, # Output only. The document id of the google doc.
          &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Revision id for the doc.
        },
        &quot;sourceAddedTimestamp&quot;: &quot;A String&quot;, # The timestamp the source was added.
        &quot;tokenCount&quot;: 42, # The number of tokens in the source.
        &quot;wordCount&quot;: 42, # The word count of the source.
        &quot;youtubeMetadata&quot;: { # Metadata about a youtube video source. # Metadata for a youtube video source.
          &quot;channelName&quot;: &quot;A String&quot;, # Output only. The channel name of the youtube video.
          &quot;videoId&quot;: &quot;A String&quot;, # Output only. The id of the youtube video.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      &quot;settings&quot;: { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
        &quot;failureReason&quot;: { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
          &quot;audioTranscriptionError&quot;: { # An audio file transcription specific error. # An audio file transcription specific error.
            &quot;languageDetectionFailed&quot;: { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
            },
            &quot;noAudioDetected&quot;: { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
            },
          },
          &quot;domainBlocked&quot;: { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
          },
          &quot;googleDriveError&quot;: { # A google drive specific error. # A google drive specific error.
            &quot;downloadPrevented&quot;: { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
            },
          },
          &quot;ingestionError&quot;: { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
          },
          &quot;mimeTypeBlocked&quot;: { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
          },
          &quot;paywallError&quot;: { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
          },
          &quot;policyCheckFailed&quot;: { # Indicates that the policy check failed. # Indicates that the policy check failed.
          },
          &quot;sourceEmpty&quot;: { # Indicates that the source is empty. # Indicates that the source is empty.
          },
          &quot;sourceLimitExceeded&quot;: { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
          },
          &quot;sourceTooLong&quot;: { # Indicates source word count exceeded the user&#x27;s limit. # Indicates source word count exceeded the user&#x27;s limit.
            &quot;wordCount&quot;: 42, # The number of words in the source.
            &quot;wordLimit&quot;: 42, # The word count limit for the current user at the time of the upload.
          },
          &quot;sourceUnreachable&quot;: { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
            &quot;errorDetails&quot;: &quot;A String&quot;, # Describes why the source is unreachable.
          },
          &quot;unknown&quot;: { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
          },
          &quot;uploadError&quot;: { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
          },
          &quot;youtubeError&quot;: { # A youtube specific error. # A youtube specific error.
            &quot;videoDeleted&quot;: { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
            },
          },
        },
        &quot;status&quot;: &quot;A String&quot;, # Status of the source.
      },
      &quot;sourceId&quot;: { # SourceId is the last segment of the source&#x27;s resource name. # Optional. Output only. Source id, which is the last segment of the source&#x27;s resource name.
        &quot;id&quot;: &quot;A String&quot;, # The id of the source.
      },
      &quot;title&quot;: &quot;A String&quot;, # Optional. Title of the source.
    },
  ],
  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the notebook.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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. # Output only. 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;, # Output only. Notebook id, which is the last segment of the notebook&#x27;s resource name.
  &quot;sources&quot;: [ # Output only. List of sources in the notebook. This is an output only field.
    { # Source represents a single source of content.
      &quot;metadata&quot;: { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
        &quot;agentspaceMetadata&quot;: { # Metadata about an agentspace source. # Metadata for an agentspace source.
          &quot;documentName&quot;: &quot;A String&quot;, # Output only. The full document name in Agentspace.
          &quot;documentTitle&quot;: &quot;A String&quot;, # Output only. The title of the document.
        },
        &quot;googleDocsMetadata&quot;: { # Metadata about a google doc source. # Metadata for a google doc source.
          &quot;documentId&quot;: &quot;A String&quot;, # Output only. The document id of the google doc.
          &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Revision id for the doc.
        },
        &quot;sourceAddedTimestamp&quot;: &quot;A String&quot;, # The timestamp the source was added.
        &quot;tokenCount&quot;: 42, # The number of tokens in the source.
        &quot;wordCount&quot;: 42, # The word count of the source.
        &quot;youtubeMetadata&quot;: { # Metadata about a youtube video source. # Metadata for a youtube video source.
          &quot;channelName&quot;: &quot;A String&quot;, # Output only. The channel name of the youtube video.
          &quot;videoId&quot;: &quot;A String&quot;, # Output only. The id of the youtube video.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      &quot;settings&quot;: { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
        &quot;failureReason&quot;: { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
          &quot;audioTranscriptionError&quot;: { # An audio file transcription specific error. # An audio file transcription specific error.
            &quot;languageDetectionFailed&quot;: { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
            },
            &quot;noAudioDetected&quot;: { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
            },
          },
          &quot;domainBlocked&quot;: { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
          },
          &quot;googleDriveError&quot;: { # A google drive specific error. # A google drive specific error.
            &quot;downloadPrevented&quot;: { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
            },
          },
          &quot;ingestionError&quot;: { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
          },
          &quot;mimeTypeBlocked&quot;: { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
          },
          &quot;paywallError&quot;: { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
          },
          &quot;policyCheckFailed&quot;: { # Indicates that the policy check failed. # Indicates that the policy check failed.
          },
          &quot;sourceEmpty&quot;: { # Indicates that the source is empty. # Indicates that the source is empty.
          },
          &quot;sourceLimitExceeded&quot;: { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
          },
          &quot;sourceTooLong&quot;: { # Indicates source word count exceeded the user&#x27;s limit. # Indicates source word count exceeded the user&#x27;s limit.
            &quot;wordCount&quot;: 42, # The number of words in the source.
            &quot;wordLimit&quot;: 42, # The word count limit for the current user at the time of the upload.
          },
          &quot;sourceUnreachable&quot;: { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
            &quot;errorDetails&quot;: &quot;A String&quot;, # Describes why the source is unreachable.
          },
          &quot;unknown&quot;: { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
          },
          &quot;uploadError&quot;: { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
          },
          &quot;youtubeError&quot;: { # A youtube specific error. # A youtube specific error.
            &quot;videoDeleted&quot;: { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
            },
          },
        },
        &quot;status&quot;: &quot;A String&quot;, # Status of the source.
      },
      &quot;sourceId&quot;: { # SourceId is the last segment of the source&#x27;s resource name. # Optional. Output only. Source id, which is the last segment of the source&#x27;s resource name.
        &quot;id&quot;: &quot;A String&quot;, # The id of the source.
      },
      &quot;title&quot;: &quot;A String&quot;, # Optional. Title of the source.
    },
  ],
  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the notebook.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a notebook.

Args:
  name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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. # Output only. 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;, # Output only. Notebook id, which is the last segment of the notebook&#x27;s resource name.
  &quot;sources&quot;: [ # Output only. List of sources in the notebook. This is an output only field.
    { # Source represents a single source of content.
      &quot;metadata&quot;: { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
        &quot;agentspaceMetadata&quot;: { # Metadata about an agentspace source. # Metadata for an agentspace source.
          &quot;documentName&quot;: &quot;A String&quot;, # Output only. The full document name in Agentspace.
          &quot;documentTitle&quot;: &quot;A String&quot;, # Output only. The title of the document.
        },
        &quot;googleDocsMetadata&quot;: { # Metadata about a google doc source. # Metadata for a google doc source.
          &quot;documentId&quot;: &quot;A String&quot;, # Output only. The document id of the google doc.
          &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Revision id for the doc.
        },
        &quot;sourceAddedTimestamp&quot;: &quot;A String&quot;, # The timestamp the source was added.
        &quot;tokenCount&quot;: 42, # The number of tokens in the source.
        &quot;wordCount&quot;: 42, # The word count of the source.
        &quot;youtubeMetadata&quot;: { # Metadata about a youtube video source. # Metadata for a youtube video source.
          &quot;channelName&quot;: &quot;A String&quot;, # Output only. The channel name of the youtube video.
          &quot;videoId&quot;: &quot;A String&quot;, # Output only. The id of the youtube video.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      &quot;settings&quot;: { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
        &quot;failureReason&quot;: { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
          &quot;audioTranscriptionError&quot;: { # An audio file transcription specific error. # An audio file transcription specific error.
            &quot;languageDetectionFailed&quot;: { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
            },
            &quot;noAudioDetected&quot;: { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
            },
          },
          &quot;domainBlocked&quot;: { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
          },
          &quot;googleDriveError&quot;: { # A google drive specific error. # A google drive specific error.
            &quot;downloadPrevented&quot;: { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
            },
          },
          &quot;ingestionError&quot;: { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
          },
          &quot;mimeTypeBlocked&quot;: { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
          },
          &quot;paywallError&quot;: { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
          },
          &quot;policyCheckFailed&quot;: { # Indicates that the policy check failed. # Indicates that the policy check failed.
          },
          &quot;sourceEmpty&quot;: { # Indicates that the source is empty. # Indicates that the source is empty.
          },
          &quot;sourceLimitExceeded&quot;: { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
          },
          &quot;sourceTooLong&quot;: { # Indicates source word count exceeded the user&#x27;s limit. # Indicates source word count exceeded the user&#x27;s limit.
            &quot;wordCount&quot;: 42, # The number of words in the source.
            &quot;wordLimit&quot;: 42, # The word count limit for the current user at the time of the upload.
          },
          &quot;sourceUnreachable&quot;: { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
            &quot;errorDetails&quot;: &quot;A String&quot;, # Describes why the source is unreachable.
          },
          &quot;unknown&quot;: { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
          },
          &quot;uploadError&quot;: { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
          },
          &quot;youtubeError&quot;: { # A youtube specific error. # A youtube specific error.
            &quot;videoDeleted&quot;: { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
            },
          },
        },
        &quot;status&quot;: &quot;A String&quot;, # Status of the source.
      },
      &quot;sourceId&quot;: { # SourceId is the last segment of the source&#x27;s resource name. # Optional. Output only. Source id, which is the last segment of the source&#x27;s resource name.
        &quot;id&quot;: &quot;A String&quot;, # The id of the source.
      },
      &quot;title&quot;: &quot;A String&quot;, # Optional. Title of the source.
    },
  ],
  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the notebook.
}</pre>
</div>

<div class="method">
    <code class="details" id="listRecentlyViewed">listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the notebooks ordered by last view time.

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;500&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. # Output only. 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;, # Output only. Notebook id, which is the last segment of the notebook&#x27;s resource name.
      &quot;sources&quot;: [ # Output only. List of sources in the notebook. This is an output only field.
        { # Source represents a single source of content.
          &quot;metadata&quot;: { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
            &quot;agentspaceMetadata&quot;: { # Metadata about an agentspace source. # Metadata for an agentspace source.
              &quot;documentName&quot;: &quot;A String&quot;, # Output only. The full document name in Agentspace.
              &quot;documentTitle&quot;: &quot;A String&quot;, # Output only. The title of the document.
            },
            &quot;googleDocsMetadata&quot;: { # Metadata about a google doc source. # Metadata for a google doc source.
              &quot;documentId&quot;: &quot;A String&quot;, # Output only. The document id of the google doc.
              &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Revision id for the doc.
            },
            &quot;sourceAddedTimestamp&quot;: &quot;A String&quot;, # The timestamp the source was added.
            &quot;tokenCount&quot;: 42, # The number of tokens in the source.
            &quot;wordCount&quot;: 42, # The word count of the source.
            &quot;youtubeMetadata&quot;: { # Metadata about a youtube video source. # Metadata for a youtube video source.
              &quot;channelName&quot;: &quot;A String&quot;, # Output only. The channel name of the youtube video.
              &quot;videoId&quot;: &quot;A String&quot;, # Output only. The id of the youtube video.
            },
          },
          &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
          &quot;settings&quot;: { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
            &quot;failureReason&quot;: { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
              &quot;audioTranscriptionError&quot;: { # An audio file transcription specific error. # An audio file transcription specific error.
                &quot;languageDetectionFailed&quot;: { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
                },
                &quot;noAudioDetected&quot;: { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
                },
              },
              &quot;domainBlocked&quot;: { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
              },
              &quot;googleDriveError&quot;: { # A google drive specific error. # A google drive specific error.
                &quot;downloadPrevented&quot;: { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
                },
              },
              &quot;ingestionError&quot;: { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
              },
              &quot;mimeTypeBlocked&quot;: { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
              },
              &quot;paywallError&quot;: { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
              },
              &quot;policyCheckFailed&quot;: { # Indicates that the policy check failed. # Indicates that the policy check failed.
              },
              &quot;sourceEmpty&quot;: { # Indicates that the source is empty. # Indicates that the source is empty.
              },
              &quot;sourceLimitExceeded&quot;: { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
              },
              &quot;sourceTooLong&quot;: { # Indicates source word count exceeded the user&#x27;s limit. # Indicates source word count exceeded the user&#x27;s limit.
                &quot;wordCount&quot;: 42, # The number of words in the source.
                &quot;wordLimit&quot;: 42, # The word count limit for the current user at the time of the upload.
              },
              &quot;sourceUnreachable&quot;: { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
                &quot;errorDetails&quot;: &quot;A String&quot;, # Describes why the source is unreachable.
              },
              &quot;unknown&quot;: { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
              },
              &quot;uploadError&quot;: { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
              },
              &quot;youtubeError&quot;: { # A youtube specific error. # A youtube specific error.
                &quot;videoDeleted&quot;: { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
                },
              },
            },
            &quot;status&quot;: &quot;A String&quot;, # Status of the source.
          },
          &quot;sourceId&quot;: { # SourceId is the last segment of the source&#x27;s resource name. # Optional. Output only. Source id, which is the last segment of the source&#x27;s resource name.
            &quot;id&quot;: &quot;A String&quot;, # The id of the source.
          },
          &quot;title&quot;: &quot;A String&quot;, # Optional. Title of the source.
        },
      ],
      &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(previous_request, previous_response)</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>

<div class="method">
    <code class="details" id="share">share(name, body=None, x__xgafv=None)</code>
  <pre>Shares a notebook to other accounts.

Args:
  name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for NotebookService.ShareNotebook method.
  &quot;accountAndRoles&quot;: [ # Required. The list of accounts and roles to share the notebook with.
    { # Account and role information.
      &quot;email&quot;: &quot;A String&quot;, # Required. The email address associated with the account.
      &quot;role&quot;: &quot;A String&quot;, # Required. The role in the notebook.
    },
  ],
  &quot;notifyViaEmail&quot;: True or False, # Required. Whether to notify the shared users via email.
}

  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.ShareNotebook method.
}</pre>
</div>

</body></html>