feat(notebooks): update the api

#### notebooks:v1 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.diagnose (Total Keys: 12) - resources.projects.resources.locations.resources.runtimes.methods.diagnose (Total Keys: 12) - resources.projects.resources.locations.resources.runtimes.methods.upgrade (Total Keys: 12) - schemas.DiagnoseInstanceRequest (Total Keys: 3) - schemas.DiagnoseRuntimeRequest (Total Keys: 3) - schemas.DiagnosticConfig (Total Keys: 7) - schemas.UpgradeRuntimeRequest (Total Keys: 3)
googleapis · Oct 11, 2022 · 9ff1945 · 9ff1945
1 parent 6183625
commit 9ff1945
Show file tree

Hide file tree

Showing 3 changed files with 292 additions and 1 deletion.
diff --git a/docs/dyn/notebooks_v1.projects.locations.instances.html b/docs/dyn/notebooks_v1.projects.locations.instances.html
@@ -83,6 +83,9 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes a single Instance.</p>
+<p class="toc_element">
+  <code><a href="#diagnose">diagnose(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a Diagnostic File and runs Diagnostic Tool given an Instance.</p>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets details of a single Instance.</p>
@@ -332,6 +335,54 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="diagnose">diagnose(name, body=None, x__xgafv=None)</code>
+  <pre>Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
+
+Args:
+  name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for creating a notebook instance diagnostic file.
+  &quot;diagnosticConfig&quot;: { # Defines flags that are used to run the diagnostic tool # Required. Defines flags that are used to run the diagnostic tool
+    &quot;copyHomeFilesFlagEnabled&quot;: True or False, # Optional. Enables flag to copy all `/home/jupyter` folder contents
+    &quot;gcsBucket&quot;: &quot;A String&quot;, # Required. User Cloud Storage bucket location (REQUIRED) ## Must be formatted with path prefix (gs://$GCS_BUCKET) Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project&#x27;s service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project&#x27;s service account or ## user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written to gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+    &quot;packetCaptureFlagEnabled&quot;: True or False, # Optional. Enables flag to capture packets from the instance for 30 seconds
+    &quot;relativePath&quot;: &quot;A String&quot;, # Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+    &quot;repairFlagEnabled&quot;: True or False, # Optional. Enables flag to repair service for instance
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
+    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>Gets details of a single Instance.

diff --git a/docs/dyn/notebooks_v1.projects.locations.runtimes.html b/docs/dyn/notebooks_v1.projects.locations.runtimes.html
@@ -83,6 +83,9 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes a single Runtime.</p>
+<p class="toc_element">
+  <code><a href="#diagnose">diagnose(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.</p>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.</p>
@@ -122,6 +125,9 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
+<p class="toc_element">
+  <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Upgrades a Managed Notebook Runtime to the latest version.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="close">close()</code>
@@ -313,6 +319,54 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="diagnose">diagnose(name, body=None, x__xgafv=None)</code>
+  <pre>Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
+
+Args:
+  name: string, Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for creating a notebook instance diagnostic file.
+  &quot;diagnosticConfig&quot;: { # Defines flags that are used to run the diagnostic tool # Required. Defines flags that are used to run the diagnostic tool
+    &quot;copyHomeFilesFlagEnabled&quot;: True or False, # Optional. Enables flag to copy all `/home/jupyter` folder contents
+    &quot;gcsBucket&quot;: &quot;A String&quot;, # Required. User Cloud Storage bucket location (REQUIRED) ## Must be formatted with path prefix (gs://$GCS_BUCKET) Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project&#x27;s service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project&#x27;s service account or ## user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written to gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+    &quot;packetCaptureFlagEnabled&quot;: True or False, # Optional. Enables flag to capture packets from the instance for 30 seconds
+    &quot;relativePath&quot;: &quot;A String&quot;, # Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+    &quot;repairFlagEnabled&quot;: True or False, # Optional. Enables flag to repair service for instance
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
+    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
@@ -1106,4 +1160,46 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
+  <pre>Upgrades a Managed Notebook Runtime to the latest version.
+
+Args:
+  name: string, Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = &quot;TRUSTED_TESTER,SPECIAL_TESTER&quot;;
+  &quot;requestId&quot;: &quot;A String&quot;, # Idempotent request UUID.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
+    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+}</pre>
+</div>
+
 </body></html>