feat(notebooks): update the api

#### notebooks:v1 The following keys were added: - schemas.ExecutionTemplate.properties.tensorboard.type (Total Keys: 1)
googleapis · Feb 22, 2022 · 77c47e9 · 77c47e9
1 parent 62cb631
commit 77c47e9
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/docs/dyn/notebooks_v1.projects.locations.executions.html b/docs/dyn/notebooks_v1.projects.locations.executions.html
@@ -132,6 +132,7 @@ <h3>Method Details</h3>
     &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
     &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
     &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+    &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
     &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
       &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
         &quot;a_key&quot;: &quot;A String&quot;,
@@ -250,6 +251,7 @@ <h3>Method Details</h3>
     &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
     &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
     &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+    &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
     &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
       &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
         &quot;a_key&quot;: &quot;A String&quot;,
@@ -310,6 +312,7 @@ <h3>Method Details</h3>
         &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
         &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
         &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+        &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
         &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
           &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
             &quot;a_key&quot;: &quot;A String&quot;,

diff --git a/docs/dyn/notebooks_v1.projects.locations.runtimes.html b/docs/dyn/notebooks_v1.projects.locations.runtimes.html
@@ -150,7 +150,7 @@ <h3>Method Details</h3>
     &quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. Default: True
     &quot;idleShutdown&quot;: True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True
     &quot;idleShutdownTimeout&quot;: 42, # Time in minutes to wait before shutting down runtime. Default: 180 minutes
-    &quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically.
+    &quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically. Default: True
     &quot;kernels&quot;: [ # Optional. Use a list of container images to use as Kernels in the notebook instance.
       { # Definition of a container image for starting a notebook instance with the environment installed in a container.
         &quot;repository&quot;: &quot;A String&quot;, # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
@@ -334,7 +334,7 @@ <h3>Method Details</h3>
     &quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. Default: True
     &quot;idleShutdown&quot;: True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True
     &quot;idleShutdownTimeout&quot;: 42, # Time in minutes to wait before shutting down runtime. Default: 180 minutes
-    &quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically.
+    &quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically. Default: True
     &quot;kernels&quot;: [ # Optional. Use a list of container images to use as Kernels in the notebook instance.
       { # Definition of a container image for starting a notebook instance with the environment installed in a container.
         &quot;repository&quot;: &quot;A String&quot;, # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
@@ -494,7 +494,7 @@ <h3>Method Details</h3>
         &quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. Default: True
         &quot;idleShutdown&quot;: True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True
         &quot;idleShutdownTimeout&quot;: 42, # Time in minutes to wait before shutting down runtime. Default: 180 minutes
-        &quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically.
+        &quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically. Default: True
         &quot;kernels&quot;: [ # Optional. Use a list of container images to use as Kernels in the notebook instance.
           { # Definition of a container image for starting a notebook instance with the environment installed in a container.
             &quot;repository&quot;: &quot;A String&quot;, # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`

diff --git a/docs/dyn/notebooks_v1.projects.locations.schedules.html b/docs/dyn/notebooks_v1.projects.locations.schedules.html
@@ -136,6 +136,7 @@ <h3>Method Details</h3>
     &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
     &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
     &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+    &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
     &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
       &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
         &quot;a_key&quot;: &quot;A String&quot;,
@@ -170,6 +171,7 @@ <h3>Method Details</h3>
         &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
         &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
         &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+        &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
         &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
           &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
             &quot;a_key&quot;: &quot;A String&quot;,
@@ -294,6 +296,7 @@ <h3>Method Details</h3>
     &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
     &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
     &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+    &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
     &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
       &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
         &quot;a_key&quot;: &quot;A String&quot;,
@@ -328,6 +331,7 @@ <h3>Method Details</h3>
         &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
         &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
         &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+        &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
         &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
           &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
             &quot;a_key&quot;: &quot;A String&quot;,
@@ -395,6 +399,7 @@ <h3>Method Details</h3>
         &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
         &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
         &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+        &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
         &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
           &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
             &quot;a_key&quot;: &quot;A String&quot;,
@@ -429,6 +434,7 @@ <h3>Method Details</h3>
             &quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
             &quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
             &quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
+            &quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
             &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
               &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
                 &quot;a_key&quot;: &quot;A String&quot;,

diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json
@@ -1743,7 +1743,7 @@
       }
     }
   },
-  "revision": "20220205",
+  "revision": "20220214",
   "rootUrl": "https://notebooks.googleapis.com/",
   "schemas": {
     "AcceleratorConfig": {
@@ -2159,6 +2159,10 @@
           "description": "The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.",
           "type": "string"
         },
+        "tensorboard": {
+          "description": "The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+          "type": "string"
+        },
         "vertexAiParameters": {
           "$ref": "VertexAIParameters",
           "description": "Parameters used in Vertex AI JobType executions."
@@ -3259,7 +3263,7 @@
           "type": "integer"
         },
         "installGpuDriver": {
-          "description": "Install Nvidia Driver automatically.",
+          "description": "Install Nvidia Driver automatically. Default: True",
           "type": "boolean"
         },
         "kernels": {