blob: b7e242b2e9fb612d200306908195d353618a4367 [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.schedules.html">schedules</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, scheduleId=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 schedule and all underlying jobs</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 schedule</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 schedules 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<p class="toc_element">
96 <code><a href="#trigger">trigger(name, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Triggers execution of an existing schedule.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="create">create(parent, body=None, scheduleId=None, x__xgafv=None)</code>
106 <pre>Creates a new Scheduled Notebook in a given project and location.
107
108Args:
109 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
110 body: object, The request body.
111 The object takes the form of:
112
113{ # The definition of a schedule.
114 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the schedule was created.
yoshi-code-bot312da312021-09-21 00:22:28 -0700115 &quot;cronSchedule&quot;: &quot;A String&quot;, # Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800116 &quot;description&quot;: &quot;A String&quot;, # A brief description of this environment.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700117 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens &#x27;-&#x27;, and underscores &#x27;_&#x27;.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800118 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule.
yoshi-code-bot312da312021-09-21 00:22:28 -0700119 &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](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800120 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
121 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
122 },
123 &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 -0700124 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700125 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700126 },
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700127 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700128 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700129 &quot;kernelSpec&quot;: &quot;A String&quot;, # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800130 &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.
131 &quot;a_key&quot;: &quot;A String&quot;,
132 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700133 &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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700134 &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://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800135 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700136 &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 -0700137 &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 -0400138 &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-bot312da312021-09-21 00:22:28 -0700139 &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700140 &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
141 &quot;a_key&quot;: &quot;A String&quot;,
142 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700143 &quot;network&quot;: &quot;A String&quot;, # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
144 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800145 },
146 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
147 &quot;recentExecutions&quot;: [ # Output only. The most recent execution names triggered from this schedule and their corresponding states.
148 { # The definition of a single executed notebook.
149 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was instantiated.
150 &quot;description&quot;: &quot;A String&quot;, # A brief description of this execution.
151 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores &#x27;_&#x27;.
152 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
yoshi-code-bot312da312021-09-21 00:22:28 -0700153 &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](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800154 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
155 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
156 },
157 &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 -0700158 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700159 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700160 },
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700161 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700162 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700163 &quot;kernelSpec&quot;: &quot;A String&quot;, # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800164 &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.
165 &quot;a_key&quot;: &quot;A String&quot;,
166 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700167 &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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700168 &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://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800169 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700170 &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 -0700171 &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 -0400172 &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-bot312da312021-09-21 00:22:28 -0700173 &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700174 &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
175 &quot;a_key&quot;: &quot;A String&quot;,
176 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700177 &quot;network&quot;: &quot;A String&quot;, # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
178 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800179 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700180 &quot;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
yoshi-code-bot312da312021-09-21 00:22:28 -0700181 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800182 &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
183 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
184 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was last updated.
185 },
186 ],
187 &quot;state&quot;: &quot;A String&quot;,
188 &quot;timeZone&quot;: &quot;A String&quot;, # Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string &quot;utc&quot;. If a time zone is not specified, the default will be in UTC (also known as GMT).
189 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the schedule was last updated.
190}
191
192 scheduleId: string, Required. User-defined unique ID of this schedule.
193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198Returns:
199 An object of the form:
200
201 { # This resource represents a long-running operation that is the result of a network API call.
202 &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.
203 &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.
204 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
205 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
206 {
207 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
208 },
209 ],
210 &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.
211 },
212 &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.
213 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
214 },
215 &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}`.
216 &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`.
217 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
218 },
219}</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
224 <pre>Deletes schedule and all underlying jobs
225
226Args:
227 name: string, Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` (required)
228 x__xgafv: string, V1 error format.
229 Allowed values
230 1 - v1 error format
231 2 - v2 error format
232
233Returns:
234 An object of the form:
235
236 { # This resource represents a long-running operation that is the result of a network API call.
237 &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.
238 &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.
239 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
240 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
241 {
242 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
243 },
244 ],
245 &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.
246 },
247 &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.
248 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
249 },
250 &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}`.
251 &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`.
252 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
253 },
254}</pre>
255</div>
256
257<div class="method">
258 <code class="details" id="get">get(name, x__xgafv=None)</code>
259 <pre>Gets details of schedule
260
261Args:
262 name: string, Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` (required)
263 x__xgafv: string, V1 error format.
264 Allowed values
265 1 - v1 error format
266 2 - v2 error format
267
268Returns:
269 An object of the form:
270
271 { # The definition of a schedule.
272 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the schedule was created.
yoshi-code-bot312da312021-09-21 00:22:28 -0700273 &quot;cronSchedule&quot;: &quot;A String&quot;, # Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800274 &quot;description&quot;: &quot;A String&quot;, # A brief description of this environment.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700275 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens &#x27;-&#x27;, and underscores &#x27;_&#x27;.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800276 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule.
yoshi-code-bot312da312021-09-21 00:22:28 -0700277 &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](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800278 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
279 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
280 },
281 &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 -0700282 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700283 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700284 },
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700285 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700286 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700287 &quot;kernelSpec&quot;: &quot;A String&quot;, # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800288 &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.
289 &quot;a_key&quot;: &quot;A String&quot;,
290 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700291 &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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700292 &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://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800293 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700294 &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 -0700295 &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 -0400296 &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-bot312da312021-09-21 00:22:28 -0700297 &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700298 &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
299 &quot;a_key&quot;: &quot;A String&quot;,
300 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700301 &quot;network&quot;: &quot;A String&quot;, # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
302 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800303 },
304 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
305 &quot;recentExecutions&quot;: [ # Output only. The most recent execution names triggered from this schedule and their corresponding states.
306 { # The definition of a single executed notebook.
307 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was instantiated.
308 &quot;description&quot;: &quot;A String&quot;, # A brief description of this execution.
309 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores &#x27;_&#x27;.
310 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
yoshi-code-bot312da312021-09-21 00:22:28 -0700311 &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](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800312 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
313 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
314 },
315 &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 -0700316 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700317 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700318 },
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700319 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700320 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700321 &quot;kernelSpec&quot;: &quot;A String&quot;, # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800322 &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.
323 &quot;a_key&quot;: &quot;A String&quot;,
324 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700325 &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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700326 &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://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800327 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700328 &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 -0700329 &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 -0400330 &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-bot312da312021-09-21 00:22:28 -0700331 &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700332 &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
333 &quot;a_key&quot;: &quot;A String&quot;,
334 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700335 &quot;network&quot;: &quot;A String&quot;, # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
336 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800337 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700338 &quot;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
yoshi-code-bot312da312021-09-21 00:22:28 -0700339 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800340 &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
341 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
342 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was last updated.
343 },
344 ],
345 &quot;state&quot;: &quot;A String&quot;,
346 &quot;timeZone&quot;: &quot;A String&quot;, # Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string &quot;utc&quot;. If a time zone is not specified, the default will be in UTC (also known as GMT).
347 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the schedule was last updated.
348}</pre>
349</div>
350
351<div class="method">
352 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
353 <pre>Lists schedules in a given project and location.
354
355Args:
356 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
357 filter: string, Filter applied to resulting schedules.
358 orderBy: string, Field to order results by.
359 pageSize: integer, Maximum return size of the list call.
360 pageToken: string, A previous returned page token that can be used to continue listing from the last result.
361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
365
366Returns:
367 An object of the form:
368
369 { # Response for listing scheduled notebook job.
370 &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.
371 &quot;schedules&quot;: [ # A list of returned instances.
372 { # The definition of a schedule.
373 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the schedule was created.
yoshi-code-bot312da312021-09-21 00:22:28 -0700374 &quot;cronSchedule&quot;: &quot;A String&quot;, # Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800375 &quot;description&quot;: &quot;A String&quot;, # A brief description of this environment.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700376 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens &#x27;-&#x27;, and underscores &#x27;_&#x27;.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800377 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule.
yoshi-code-bot312da312021-09-21 00:22:28 -0700378 &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](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800379 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
380 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
381 },
382 &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 -0700383 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700384 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700385 },
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700386 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700387 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700388 &quot;kernelSpec&quot;: &quot;A String&quot;, # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800389 &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.
390 &quot;a_key&quot;: &quot;A String&quot;,
391 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700392 &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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700393 &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://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800394 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700395 &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 -0700396 &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 -0400397 &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-bot312da312021-09-21 00:22:28 -0700398 &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700399 &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
400 &quot;a_key&quot;: &quot;A String&quot;,
401 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700402 &quot;network&quot;: &quot;A String&quot;, # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
403 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800404 },
405 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
406 &quot;recentExecutions&quot;: [ # Output only. The most recent execution names triggered from this schedule and their corresponding states.
407 { # The definition of a single executed notebook.
408 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was instantiated.
409 &quot;description&quot;: &quot;A String&quot;, # A brief description of this execution.
410 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores &#x27;_&#x27;.
411 &quot;executionTemplate&quot;: { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
yoshi-code-bot312da312021-09-21 00:22:28 -0700412 &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](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800413 &quot;coreCount&quot;: &quot;A String&quot;, # Count of cores of this accelerator.
414 &quot;type&quot;: &quot;A String&quot;, # Type of this accelerator.
415 },
416 &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 -0700417 &quot;dataprocParameters&quot;: { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700418 &quot;cluster&quot;: &quot;A String&quot;, # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700419 },
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700420 &quot;inputNotebookFile&quot;: &quot;A String&quot;, # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-botcdf480e2021-08-17 00:20:40 -0700421 &quot;jobType&quot;: &quot;A String&quot;, # The type of Job to be used on this execution.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700422 &quot;kernelSpec&quot;: &quot;A String&quot;, # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800423 &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.
424 &quot;a_key&quot;: &quot;A String&quot;,
425 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700426 &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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700427 &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://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800428 &quot;parameters&quot;: &quot;A String&quot;, # Parameters used within the &#x27;input_notebook_file&#x27; notebook.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700429 &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 -0700430 &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 -0400431 &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-bot312da312021-09-21 00:22:28 -0700432 &quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700433 &quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
434 &quot;a_key&quot;: &quot;A String&quot;,
435 },
yoshi-code-bot312da312021-09-21 00:22:28 -0700436 &quot;network&quot;: &quot;A String&quot;, # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
437 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800438 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700439 &quot;jobUri&quot;: &quot;A String&quot;, # Output only. The URI of the external job used to execute the notebook.
yoshi-code-bot312da312021-09-21 00:22:28 -0700440 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800441 &quot;outputNotebookFile&quot;: &quot;A String&quot;, # Output notebook file generated by this execution
442 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the underlying AI Platform job.
443 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the Execution was last updated.
444 },
445 ],
446 &quot;state&quot;: &quot;A String&quot;,
447 &quot;timeZone&quot;: &quot;A String&quot;, # Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string &quot;utc&quot;. If a time zone is not specified, the default will be in UTC (also known as GMT).
448 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the schedule was last updated.
449 },
450 ],
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700451 &quot;unreachable&quot;: [ # Schedules that could not be reached. For example: [&#x27;projects/{project_id}/location/{location}/schedules/monthly_digest&#x27;, &#x27;projects/{project_id}/location/{location}/schedules/weekly_sentiment&#x27;]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800452 &quot;A String&quot;,
453 ],
454}</pre>
455</div>
456
457<div class="method">
458 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
459 <pre>Retrieves the next page of results.
460
461Args:
462 previous_request: The request for the previous page. (required)
463 previous_response: The response from the request for the previous page. (required)
464
465Returns:
466 A request object that you can call &#x27;execute()&#x27; on to request the next
467 page. Returns None if there are no more items in the collection.
468 </pre>
469</div>
470
471<div class="method">
472 <code class="details" id="trigger">trigger(name, body=None, x__xgafv=None)</code>
473 <pre>Triggers execution of an existing schedule.
474
475Args:
476 name: string, Required. Format: `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}` (required)
477 body: object, The request body.
478 The object takes the form of:
479
480{ # Request for created scheduled notebooks
481}
482
483 x__xgafv: string, V1 error format.
484 Allowed values
485 1 - v1 error format
486 2 - v2 error format
487
488Returns:
489 An object of the form:
490
491 { # This resource represents a long-running operation that is the result of a network API call.
492 &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.
493 &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.
494 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
495 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
496 {
497 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
498 },
499 ],
500 &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.
501 },
502 &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.
503 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
504 },
505 &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}`.
506 &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`.
507 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
508 },
509}</pre>
510</div>
511
512</body></html>