| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | |
| 108 | Args: |
| 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 | "createTime": "A String", # Output only. Time the schedule was created. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 115 | "cronSchedule": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 116 | "description": "A String", # A brief description of this environment. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame] | 117 | "displayName": "A String", # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 118 | "executionTemplate": { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 119 | "acceleratorConfig": { # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 120 | "coreCount": "A String", # Count of cores of this accelerator. |
| 121 | "type": "A String", # Type of this accelerator. |
| 122 | }, |
| 123 | "containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 124 | "dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 125 | "cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 126 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 127 | "inputNotebookFile": "A String", # 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-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 128 | "jobType": "A String", # The type of Job to be used on this execution. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 129 | "kernelSpec": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 130 | "labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions. |
| 131 | "a_key": "A String", |
| 132 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 133 | "masterType": "A String", # Specifies the type of virtual machine to use for your training job'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-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 134 | "outputNotebookFolder": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 135 | "parameters": "A String", # Parameters used within the 'input_notebook_file' notebook. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 136 | "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` |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 137 | "scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 138 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 139 | "vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 140 | "env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/ |
| 141 | "a_key": "A String", |
| 142 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 143 | "network": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 145 | }, |
| 146 | "name": "A String", # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` |
| 147 | "recentExecutions": [ # Output only. The most recent execution names triggered from this schedule and their corresponding states. |
| 148 | { # The definition of a single executed notebook. |
| 149 | "createTime": "A String", # Output only. Time the Execution was instantiated. |
| 150 | "description": "A String", # A brief description of this execution. |
| 151 | "displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'. |
| 152 | "executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 153 | "acceleratorConfig": { # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 154 | "coreCount": "A String", # Count of cores of this accelerator. |
| 155 | "type": "A String", # Type of this accelerator. |
| 156 | }, |
| 157 | "containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 158 | "dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 159 | "cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 160 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 161 | "inputNotebookFile": "A String", # 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-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 162 | "jobType": "A String", # The type of Job to be used on this execution. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 163 | "kernelSpec": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 164 | "labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions. |
| 165 | "a_key": "A String", |
| 166 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 167 | "masterType": "A String", # Specifies the type of virtual machine to use for your training job'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-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 168 | "outputNotebookFolder": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 169 | "parameters": "A String", # Parameters used within the 'input_notebook_file' notebook. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 170 | "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` |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 171 | "scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 172 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 173 | "vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 174 | "env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/ |
| 175 | "a_key": "A String", |
| 176 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 177 | "network": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 179 | }, |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 180 | "jobUri": "A String", # Output only. The URI of the external job used to execute the notebook. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 181 | "name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 182 | "outputNotebookFile": "A String", # Output notebook file generated by this execution |
| 183 | "state": "A String", # Output only. State of the underlying AI Platform job. |
| 184 | "updateTime": "A String", # Output only. Time the Execution was last updated. |
| 185 | }, |
| 186 | ], |
| 187 | "state": "A String", |
| 188 | "timeZone": "A String", # 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 "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). |
| 189 | "updateTime": "A String", # 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 | |
| 198 | Returns: |
| 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 | "done": 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 | "error": { # 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 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 205 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 206 | { |
| 207 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 208 | }, |
| 209 | ], |
| 210 | "message": "A String", # 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 | "metadata": { # 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 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 214 | }, |
| 215 | "name": "A String", # 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 | "response": { # 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 | "a_key": "", # 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 | |
| 226 | Args: |
| 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 | |
| 233 | Returns: |
| 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 | "done": 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 | "error": { # 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 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 240 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 241 | { |
| 242 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 243 | }, |
| 244 | ], |
| 245 | "message": "A String", # 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 | "metadata": { # 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 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 249 | }, |
| 250 | "name": "A String", # 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 | "response": { # 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 | "a_key": "", # 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 | |
| 261 | Args: |
| 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 | |
| 268 | Returns: |
| 269 | An object of the form: |
| 270 | |
| 271 | { # The definition of a schedule. |
| 272 | "createTime": "A String", # Output only. Time the schedule was created. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 273 | "cronSchedule": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 274 | "description": "A String", # A brief description of this environment. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame] | 275 | "displayName": "A String", # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 276 | "executionTemplate": { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 277 | "acceleratorConfig": { # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 278 | "coreCount": "A String", # Count of cores of this accelerator. |
| 279 | "type": "A String", # Type of this accelerator. |
| 280 | }, |
| 281 | "containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 282 | "dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 283 | "cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 284 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 285 | "inputNotebookFile": "A String", # 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-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 286 | "jobType": "A String", # The type of Job to be used on this execution. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 287 | "kernelSpec": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 288 | "labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions. |
| 289 | "a_key": "A String", |
| 290 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 291 | "masterType": "A String", # Specifies the type of virtual machine to use for your training job'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-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 292 | "outputNotebookFolder": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 293 | "parameters": "A String", # Parameters used within the 'input_notebook_file' notebook. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 294 | "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` |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 295 | "scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 296 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 297 | "vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 298 | "env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/ |
| 299 | "a_key": "A String", |
| 300 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 301 | "network": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 303 | }, |
| 304 | "name": "A String", # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` |
| 305 | "recentExecutions": [ # Output only. The most recent execution names triggered from this schedule and their corresponding states. |
| 306 | { # The definition of a single executed notebook. |
| 307 | "createTime": "A String", # Output only. Time the Execution was instantiated. |
| 308 | "description": "A String", # A brief description of this execution. |
| 309 | "displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'. |
| 310 | "executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 311 | "acceleratorConfig": { # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 312 | "coreCount": "A String", # Count of cores of this accelerator. |
| 313 | "type": "A String", # Type of this accelerator. |
| 314 | }, |
| 315 | "containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 316 | "dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 317 | "cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 318 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 319 | "inputNotebookFile": "A String", # 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-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 320 | "jobType": "A String", # The type of Job to be used on this execution. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 321 | "kernelSpec": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 322 | "labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions. |
| 323 | "a_key": "A String", |
| 324 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 325 | "masterType": "A String", # Specifies the type of virtual machine to use for your training job'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-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 326 | "outputNotebookFolder": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 327 | "parameters": "A String", # Parameters used within the 'input_notebook_file' notebook. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 328 | "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` |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 329 | "scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 330 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 331 | "vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 332 | "env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/ |
| 333 | "a_key": "A String", |
| 334 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 335 | "network": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 337 | }, |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 338 | "jobUri": "A String", # Output only. The URI of the external job used to execute the notebook. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 339 | "name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 340 | "outputNotebookFile": "A String", # Output notebook file generated by this execution |
| 341 | "state": "A String", # Output only. State of the underlying AI Platform job. |
| 342 | "updateTime": "A String", # Output only. Time the Execution was last updated. |
| 343 | }, |
| 344 | ], |
| 345 | "state": "A String", |
| 346 | "timeZone": "A String", # 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 "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). |
| 347 | "updateTime": "A String", # 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 | |
| 355 | Args: |
| 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 | |
| 366 | Returns: |
| 367 | An object of the form: |
| 368 | |
| 369 | { # Response for listing scheduled notebook job. |
| 370 | "nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call. |
| 371 | "schedules": [ # A list of returned instances. |
| 372 | { # The definition of a schedule. |
| 373 | "createTime": "A String", # Output only. Time the schedule was created. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 374 | "cronSchedule": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 375 | "description": "A String", # A brief description of this environment. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame] | 376 | "displayName": "A String", # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 377 | "executionTemplate": { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 378 | "acceleratorConfig": { # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 379 | "coreCount": "A String", # Count of cores of this accelerator. |
| 380 | "type": "A String", # Type of this accelerator. |
| 381 | }, |
| 382 | "containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 383 | "dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 384 | "cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 385 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 386 | "inputNotebookFile": "A String", # 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-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 387 | "jobType": "A String", # The type of Job to be used on this execution. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 388 | "kernelSpec": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 389 | "labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions. |
| 390 | "a_key": "A String", |
| 391 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 392 | "masterType": "A String", # Specifies the type of virtual machine to use for your training job'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-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 393 | "outputNotebookFolder": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 394 | "parameters": "A String", # Parameters used within the 'input_notebook_file' notebook. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 395 | "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` |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 396 | "scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 397 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 398 | "vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 399 | "env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/ |
| 400 | "a_key": "A String", |
| 401 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 402 | "network": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 404 | }, |
| 405 | "name": "A String", # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` |
| 406 | "recentExecutions": [ # Output only. The most recent execution names triggered from this schedule and their corresponding states. |
| 407 | { # The definition of a single executed notebook. |
| 408 | "createTime": "A String", # Output only. Time the Execution was instantiated. |
| 409 | "description": "A String", # A brief description of this execution. |
| 410 | "displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'. |
| 411 | "executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 412 | "acceleratorConfig": { # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 413 | "coreCount": "A String", # Count of cores of this accelerator. |
| 414 | "type": "A String", # Type of this accelerator. |
| 415 | }, |
| 416 | "containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 417 | "dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 418 | "cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` |
| yoshi-code-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 419 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 420 | "inputNotebookFile": "A String", # 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-bot | cdf480e | 2021-08-17 00:20:40 -0700 | [diff] [blame] | 421 | "jobType": "A String", # The type of Job to be used on this execution. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 422 | "kernelSpec": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 423 | "labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions. |
| 424 | "a_key": "A String", |
| 425 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 426 | "masterType": "A String", # Specifies the type of virtual machine to use for your training job'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-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 427 | "outputNotebookFolder": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 428 | "parameters": "A String", # Parameters used within the 'input_notebook_file' notebook. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 429 | "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` |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 430 | "scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 431 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 432 | "vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 433 | "env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/ |
| 434 | "a_key": "A String", |
| 435 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 436 | "network": "A String", # 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-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 438 | }, |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 439 | "jobUri": "A String", # Output only. The URI of the external job used to execute the notebook. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 440 | "name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 441 | "outputNotebookFile": "A String", # Output notebook file generated by this execution |
| 442 | "state": "A String", # Output only. State of the underlying AI Platform job. |
| 443 | "updateTime": "A String", # Output only. Time the Execution was last updated. |
| 444 | }, |
| 445 | ], |
| 446 | "state": "A String", |
| 447 | "timeZone": "A String", # 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 "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). |
| 448 | "updateTime": "A String", # Output only. Time the schedule was last updated. |
| 449 | }, |
| 450 | ], |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 451 | "unreachable": [ # Schedules that could not be reached. For example: ['projects/{project_id}/location/{location}/schedules/monthly_digest', 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'] |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 452 | "A String", |
| 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 | |
| 461 | Args: |
| 462 | previous_request: The request for the previous page. (required) |
| 463 | previous_response: The response from the request for the previous page. (required) |
| 464 | |
| 465 | Returns: |
| 466 | A request object that you can call 'execute()' 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 | |
| 475 | Args: |
| 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 | |
| 488 | Returns: |
| 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 | "done": 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 | "error": { # 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 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 495 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 496 | { |
| 497 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 498 | }, |
| 499 | ], |
| 500 | "message": "A String", # 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 | "metadata": { # 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 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 504 | }, |
| 505 | "name": "A String", # 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 | "response": { # 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 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 508 | }, |
| 509 | }</pre> |
| 510 | </div> |
| 511 | |
| 512 | </body></html> |