You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/notebooks_v1.projects.locations.executions.html
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -125,9 +125,10 @@ <h3>Method Details</h3>
125
125
"outputNotebookFolder": "A String", # 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
126
126
"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
127
127
"paramsYamlFile": "A String", # 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
128
-
"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.
128
+
"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
129
129
"serviceAccount": "A String", # 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.
130
130
},
131
+
"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.
131
132
"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
132
133
"outputNotebookFile": "A String", # Output notebook file generated by this execution
133
134
"state": "A String", # Output only. State of the underlying AI Platform job.
@@ -231,9 +232,10 @@ <h3>Method Details</h3>
231
232
"outputNotebookFolder": "A String", # 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
232
233
"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
233
234
"paramsYamlFile": "A String", # 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
234
-
"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.
235
+
"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
235
236
"serviceAccount": "A String", # 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.
236
237
},
238
+
"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.
237
239
"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
238
240
"outputNotebookFile": "A String", # Output notebook file generated by this execution
239
241
"state": "A String", # Output only. State of the underlying AI Platform job.
@@ -279,9 +281,10 @@ <h3>Method Details</h3>
279
281
"outputNotebookFolder": "A String", # 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
280
282
"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
281
283
"paramsYamlFile": "A String", # 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
282
-
"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.
284
+
"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
283
285
"serviceAccount": "A String", # 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.
284
286
},
287
+
"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.
285
288
"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
286
289
"outputNotebookFile": "A String", # Output notebook file generated by this execution
287
290
"state": "A String", # Output only. State of the underlying AI Platform job.
Copy file name to clipboardExpand all lines: docs/dyn/notebooks_v1.projects.locations.instances.html
+21Lines changed: 21 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -219,6 +219,13 @@ <h3>Method Details</h3>
219
219
"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
220
220
"postStartupScript": "A String", # 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).
221
221
"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
222
+
"reservationAffinity": { # 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.
223
+
"consumeReservationType": "A String", # Optional. Type of reservation to consume
224
+
"key": "A String", # Optional. Corresponds to the label key of reservation resource.
225
+
"values": [ # Optional. Corresponds to the label values of reservation resource.
226
+
"A String",
227
+
],
228
+
},
222
229
"serviceAccount": "A String", # 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.
223
230
"serviceAccountScopes": [ # 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
224
231
"A String",
@@ -392,6 +399,13 @@ <h3>Method Details</h3>
392
399
"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
393
400
"postStartupScript": "A String", # 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).
394
401
"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
402
+
"reservationAffinity": { # 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.
403
+
"consumeReservationType": "A String", # Optional. Type of reservation to consume
404
+
"key": "A String", # Optional. Corresponds to the label key of reservation resource.
405
+
"values": [ # Optional. Corresponds to the label values of reservation resource.
406
+
"A String",
407
+
],
408
+
},
395
409
"serviceAccount": "A String", # 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.
396
410
"serviceAccountScopes": [ # 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
397
411
"A String",
@@ -584,6 +598,13 @@ <h3>Method Details</h3>
584
598
"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
585
599
"postStartupScript": "A String", # 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).
586
600
"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
601
+
"reservationAffinity": { # 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.
602
+
"consumeReservationType": "A String", # Optional. Type of reservation to consume
603
+
"key": "A String", # Optional. Corresponds to the label key of reservation resource.
604
+
"values": [ # Optional. Corresponds to the label values of reservation resource.
605
+
"A String",
606
+
],
607
+
},
587
608
"serviceAccount": "A String", # 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.
588
609
"serviceAccountScopes": [ # 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
0 commit comments