blob: 8f1dc628874c38fc3c68b346c44fc98e8a719659 [file] [log] [blame]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="notebooks_v1.html">Notebooks API</a> . <a href="notebooks_v1.projects.html">projects</a> . <a href="notebooks_v1.projects.locations.html">locations</a> . <a href="notebooks_v1.projects.locations.executions.html">executions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body=None, executionId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a new Scheduled Notebook in a given project and location.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes execution</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets details of executions</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists executions in a given project and location</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, executionId=None, x__xgafv=None)</code>
103 <pre>Creates a new Scheduled Notebook in a given project and location.
104
105Args:
106 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
107 body: object, The request body.
108 The object takes the form of:
109
110{ # The definition of a single executed notebook.
111 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was instantiated.
112 &quot;description&quot;: &quot;A String&quot;, # A brief description of this execution.
113 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores &#x27;_&#x27;.
114 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
115 &quot;acceleratorConfig&quot;: { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
116 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
117 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
118 },
119 &quot;containerImageUri&quot;: &quot;A String&quot;, # Container Image URI to a DLVM Example: &#x27;gcr.io/deeplearning-platform-release/base-cu100&#x27; More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700120 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
121 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: &#x27;projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
122 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800123 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700124 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800125 &quot;labels&quot;: { # Labels for execution. If execution is scheduled, a field included will be &#x27;nbs-scheduled&#x27;. Otherwise, it is an immediate execution, and an included field will be &#x27;nbs-immediate&#x27;. Use fields to efficiently index between various types of executions.
126 &quot;a_key&quot;: &quot;A String&quot;,
127 },
128 &quot;masterType&quot;: &quot;A String&quot;, # Specifies the type of virtual machine to use for your training job&#x27;s master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.
129 &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
130 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
131 &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
yoshi-code-bot07708072021-07-20 00:20:24 -0700132 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400133 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800134 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700135 &quot;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800136 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
137 &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
138 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
139 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was last updated.
140}
141
142 executionId: string, Required. User-defined unique ID of this execution.
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148Returns:
149 An object of the form:
150
151 { # This resource represents a long-running operation that is the result of a network API call.
152 &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.
153 &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.
154 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
155 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
156 {
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159 ],
160 &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.
161 },
162 &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.
163 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
164 },
165 &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}`.
166 &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`.
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
169}</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
174 <pre>Deletes execution
175
176Args:
177 name: string, Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` (required)
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183Returns:
184 An object of the form:
185
186 { # This resource represents a long-running operation that is the result of a network API call.
187 &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.
188 &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.
189 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
190 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
191 {
192 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
193 },
194 ],
195 &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.
196 },
197 &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.
198 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
199 },
200 &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}`.
201 &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`.
202 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
203 },
204}</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="get">get(name, x__xgafv=None)</code>
209 <pre>Gets details of executions
210
211Args:
yoshi-code-botb539cc42021-08-03 00:20:27 -0700212 name: string, Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` (required)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
221 { # The definition of a single executed notebook.
222 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was instantiated.
223 &quot;description&quot;: &quot;A String&quot;, # A brief description of this execution.
224 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores &#x27;_&#x27;.
225 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
226 &quot;acceleratorConfig&quot;: { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
227 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
228 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
229 },
230 &quot;containerImageUri&quot;: &quot;A String&quot;, # Container Image URI to a DLVM Example: &#x27;gcr.io/deeplearning-platform-release/base-cu100&#x27; More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700231 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
232 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: &#x27;projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
233 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800234 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700235 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800236 &quot;labels&quot;: { # Labels for execution. If execution is scheduled, a field included will be &#x27;nbs-scheduled&#x27;. Otherwise, it is an immediate execution, and an included field will be &#x27;nbs-immediate&#x27;. Use fields to efficiently index between various types of executions.
237 &quot;a_key&quot;: &quot;A String&quot;,
238 },
239 &quot;masterType&quot;: &quot;A String&quot;, # Specifies the type of virtual machine to use for your training job&#x27;s master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.
240 &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
241 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
242 &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
yoshi-code-bot07708072021-07-20 00:20:24 -0700243 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400244 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800245 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700246 &quot;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800247 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
248 &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
249 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
250 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was last updated.
251}</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
256 <pre>Lists executions in a given project and location
257
258Args:
259 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700260 filter: string, Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id. Format: &quot;schedule_id=&quot;
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800261 orderBy: string, Sort by field.
262 pageSize: integer, Maximum return size of the list call.
263 pageToken: string, A previous returned page token that can be used to continue listing from the last result.
264 x__xgafv: string, V1 error format.
265 Allowed values
266 1 - v1 error format
267 2 - v2 error format
268
269Returns:
270 An object of the form:
271
272 { # Response for listing scheduled notebook executions
273 &quot;executions&quot;: [ # A list of returned instances.
274 { # The definition of a single executed notebook.
275 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was instantiated.
276 &quot;description&quot;: &quot;A String&quot;, # A brief description of this execution.
277 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores &#x27;_&#x27;.
278 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
279 &quot;acceleratorConfig&quot;: { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
280 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
281 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
282 },
283 &quot;containerImageUri&quot;: &quot;A String&quot;, # Container Image URI to a DLVM Example: &#x27;gcr.io/deeplearning-platform-release/base-cu100&#x27; More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700284 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
285 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: &#x27;projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
286 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800287 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700288 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800289 &quot;labels&quot;: { # Labels for execution. If execution is scheduled, a field included will be &#x27;nbs-scheduled&#x27;. Otherwise, it is an immediate execution, and an included field will be &#x27;nbs-immediate&#x27;. Use fields to efficiently index between various types of executions.
290 &quot;a_key&quot;: &quot;A String&quot;,
291 },
292 &quot;masterType&quot;: &quot;A String&quot;, # Specifies the type of virtual machine to use for your training job&#x27;s master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.
293 &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
294 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
295 &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
yoshi-code-bot07708072021-07-20 00:20:24 -0700296 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400297 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800298 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700299 &quot;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800300 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
301 &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
302 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
303 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was last updated.
304 },
305 ],
306 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token that can be used to continue listing from the last result in the next list call.
307 &quot;unreachable&quot;: [ # Executions IDs that could not be reached. For example, [&#x27;projects/{project_id}/location/{location}/executions/imagenet_test1&#x27;, &#x27;projects/{project_id}/location/{location}/executions/classifier_train1&#x27;].
308 &quot;A String&quot;,
309 ],
310}</pre>
311</div>
312
313<div class="method">
314 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
315 <pre>Retrieves the next page of results.
316
317Args:
318 previous_request: The request for the previous page. (required)
319 previous_response: The response from the request for the previous page. (required)
320
321Returns:
322 A request object that you can call &#x27;execute()&#x27; on to request the next
323 page. Returns None if there are no more items in the collection.
324 </pre>
325</div>
326
327</body></html>