feat(notebooks): update the api

#### notebooks:v1 The following keys were added: - resources.projects.resources.locations.resources.runtimes.methods.reportEvent (Total Keys: 12) - schemas.Event (Total Keys: 5) - schemas.Execution.properties.jobUri (Total Keys: 2) - schemas.Instance.properties.reservationAffinity.$ref (Total Keys: 1) - schemas.ReportRuntimeEventRequest (Total Keys: 4) - schemas.ReservationAffinity (Total Keys: 6)
googleapis · Jul 20, 2021 · c4698a8 · c4698a8
1 parent 00cef9b
commit c4698a8
Show file tree

Hide file tree

Showing 5 changed files with 217 additions and 25 deletions.
diff --git a/docs/dyn/notebooks_v1.projects.locations.executions.html b/docs/dyn/notebooks_v1.projects.locations.executions.html
@@ -125,9 +125,10 @@ <h3>Method Details</h3>
     &quot;outputNotebookFolder&quot;: &quot;A String&quot;, # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks
     &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
     &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.
+    &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;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
   &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
   &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
   &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
@@ -231,9 +232,10 @@ <h3>Method Details</h3>
     &quot;outputNotebookFolder&quot;: &quot;A String&quot;, # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks
     &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
     &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.
+    &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;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
   &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
   &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
   &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
@@ -279,9 +281,10 @@ <h3>Method Details</h3>
         &quot;outputNotebookFolder&quot;: &quot;A String&quot;, # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks
         &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
         &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.
+        &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;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
       &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
       &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
       &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.

diff --git a/docs/dyn/notebooks_v1.projects.locations.instances.html b/docs/dyn/notebooks_v1.projects.locations.instances.html
@@ -219,6 +219,13 @@ <h3>Method Details</h3>
   &quot;noRemoveDataDisk&quot;: True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
   &quot;postStartupScript&quot;: &quot;A String&quot;, # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
   &quot;proxyUri&quot;: &quot;A String&quot;, # Output only. The proxy endpoint that is used to access the Jupyter notebook.
+  &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
+    &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
+    &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
+    &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
+      &quot;A String&quot;,
+    ],
+  },
   &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
   &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
     &quot;A String&quot;,
@@ -392,6 +399,13 @@ <h3>Method Details</h3>
   &quot;noRemoveDataDisk&quot;: True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
   &quot;postStartupScript&quot;: &quot;A String&quot;, # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
   &quot;proxyUri&quot;: &quot;A String&quot;, # Output only. The proxy endpoint that is used to access the Jupyter notebook.
+  &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
+    &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
+    &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
+    &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
+      &quot;A String&quot;,
+    ],
+  },
   &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
   &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
     &quot;A String&quot;,
@@ -584,6 +598,13 @@ <h3>Method Details</h3>
       &quot;noRemoveDataDisk&quot;: True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
       &quot;postStartupScript&quot;: &quot;A String&quot;, # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
       &quot;proxyUri&quot;: &quot;A String&quot;, # Output only. The proxy endpoint that is used to access the Jupyter notebook.
+      &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
+        &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
+        &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
+        &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
+          &quot;A String&quot;,
+        ],
+      },
       &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
       &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
         &quot;A String&quot;,