Blame - docs/dyn/notebooks_v1.projects.locations.schedules.html - platform/external/python/google-api-python-client

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

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

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

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

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

2021-08-17 00:20:40 -0700

[diff] [blame]

124

"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.

125

"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

126

},

yoshi-code-bot

2021-09-21 00:22:28 -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

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

2021-03-02 11:49:08 -0800

[diff] [blame]

129

"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.

130

"a_key": "A String",

131

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

132

"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).

133

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

134

"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.

135

"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

2021-07-20 00:20:24 -0700

[diff] [blame]

136

"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

2021-04-13 14:47:53 -0400

[diff] [blame]

137

"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

2021-09-21 00:22:28 -0700

[diff] [blame]

138

"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.

139

"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.

140

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

141

},

142

"name": "A String", # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`

143

"recentExecutions": [ # Output only. The most recent execution names triggered from this schedule and their corresponding states.

144

{ # The definition of a single executed notebook.

145

"createTime": "A String", # Output only. Time the Execution was instantiated.

146

"description": "A String", # A brief description of this execution.

147

"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

148

"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

149

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

150

"coreCount": "A String", # Count of cores of this accelerator.

151

"type": "A String", # Type of this accelerator.

152

},

153

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

154

"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.

155

"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

156

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

157

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

158

"jobType": "A String", # The type of Job to be used on this execution.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

159

"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.

160

"a_key": "A String",

161

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

162

"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).

163

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

164

"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.

165

"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

2021-07-20 00:20:24 -0700

[diff] [blame]

166

"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

2021-04-13 14:47:53 -0400

[diff] [blame]

167

"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

2021-09-21 00:22:28 -0700

[diff] [blame]

168

"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.

169

"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.

170

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

171

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

172

"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

173

"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

174

"outputNotebookFile": "A String", # Output notebook file generated by this execution

175

"state": "A String", # Output only. State of the underlying AI Platform job.

176

"updateTime": "A String", # Output only. Time the Execution was last updated.

},

],

"state": "A String",

"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).

181

"updateTime": "A String", # Output only. Time the schedule was last updated.

182

}

183

184

scheduleId: string, Required. User-defined unique ID of this schedule.

185

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

192

193

{ # This resource represents a long-running operation that is the result of a network API call.

194

"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.

195

"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.

196

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

197

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

198

{

199

"a_key": "", # Properties of the object. Contains field @type with type URL.

200

},

201

],

202

"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.

203

},

204

"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.

205

"a_key": "", # Properties of the object. Contains field @type with type URL.

206

},

207

"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}`.

208

"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`.

209

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

216

<pre>Deletes schedule and all underlying jobs

217

218

Args:

219

name: string, Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` (required)

220

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

227

228

{ # This resource represents a long-running operation that is the result of a network API call.

229

"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.

230

"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.

231

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

232

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

233

{

234

"a_key": "", # Properties of the object. Contains field @type with type URL.

235

},

236

],

237

"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.

238

},

239

"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.

240

"a_key": "", # Properties of the object. Contains field @type with type URL.

241

},

242

"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}`.

243

"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`.

244

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

251

<pre>Gets details of schedule

252

253

Args:

254

name: string, Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` (required)

255

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

262

263

{ # The definition of a schedule.

264

"createTime": "A String", # Output only. Time the schedule was created.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

265

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

266

"description": "A String", # A brief description of this environment.

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

267

"displayName": "A String", # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

268

"executionTemplate": { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

269

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

270

"coreCount": "A String", # Count of cores of this accelerator.

271

"type": "A String", # Type of this accelerator.

272

},

273

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

274

"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.

275

"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

276

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

277

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

278

"jobType": "A String", # The type of Job to be used on this execution.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

279

"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.

280

"a_key": "A String",

281

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

282

"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).

283

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

284

"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.

285

"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

2021-07-20 00:20:24 -0700

[diff] [blame]

286

"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

2021-04-13 14:47:53 -0400

[diff] [blame]

287

"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

2021-09-21 00:22:28 -0700

[diff] [blame]

288

"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.

289

"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.

290

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

291

},

292

"name": "A String", # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`

293

"recentExecutions": [ # Output only. The most recent execution names triggered from this schedule and their corresponding states.

294

{ # The definition of a single executed notebook.

295

"createTime": "A String", # Output only. Time the Execution was instantiated.

296

"description": "A String", # A brief description of this execution.

297

"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

298

"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

299

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

300

"coreCount": "A String", # Count of cores of this accelerator.

301

"type": "A String", # Type of this accelerator.

302

},

303

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

304

"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.

305

"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

306

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

307

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

308

"jobType": "A String", # The type of Job to be used on this execution.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

309

"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.

310

"a_key": "A String",

311

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

312

"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).

313

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

314

"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.

315

"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

2021-07-20 00:20:24 -0700

[diff] [blame]

316

"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

2021-04-13 14:47:53 -0400

[diff] [blame]

317

"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

2021-09-21 00:22:28 -0700

[diff] [blame]

318

"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.

319

"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.

320

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

321

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

322

"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

323

"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

324

"outputNotebookFile": "A String", # Output notebook file generated by this execution

325

"state": "A String", # Output only. State of the underlying AI Platform job.

326

"updateTime": "A String", # Output only. Time the Execution was last updated.

},

],

"state": "A String",

"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).

331

"updateTime": "A String", # Output only. Time the schedule was last updated.

}</pre>

</div>

<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

337

<pre>Lists schedules in a given project and location.

338

339

Args:

340

parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)

341

filter: string, Filter applied to resulting schedules.

342

orderBy: string, Field to order results by.

343

pageSize: integer, Maximum return size of the list call.

344

pageToken: string, A previous returned page token that can be used to continue listing from the last result.

345

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

352

353

{ # Response for listing scheduled notebook job.

354

"nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call.

355

"schedules": [ # A list of returned instances.

356

{ # The definition of a schedule.

357

"createTime": "A String", # Output only. Time the schedule was created.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

358

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

359

"description": "A String", # A brief description of this environment.

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

360

"displayName": "A String", # Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

361

"executionTemplate": { # The description a notebook execution workload. # Notebook Execution Template corresponding to this schedule.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

362

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

363

"coreCount": "A String", # Count of cores of this accelerator.

364

"type": "A String", # Type of this accelerator.

365

},

366

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

367

"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.

368

"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

369

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

370

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

371

"jobType": "A String", # The type of Job to be used on this execution.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

372

"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.

373

"a_key": "A String",

374

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

375

"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).

376

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

377

"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.

378

"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

2021-07-20 00:20:24 -0700

[diff] [blame]

379

"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

2021-04-13 14:47:53 -0400

[diff] [blame]

380

"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

2021-09-21 00:22:28 -0700

[diff] [blame]

381

"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.

382

"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.

383

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

384

},

385

"name": "A String", # Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`

386

"recentExecutions": [ # Output only. The most recent execution names triggered from this schedule and their corresponding states.

387

{ # The definition of a single executed notebook.

388

"createTime": "A String", # Output only. Time the Execution was instantiated.

389

"description": "A String", # A brief description of this execution.

390

"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

391

"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

392

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

393

"coreCount": "A String", # Count of cores of this accelerator.

394

"type": "A String", # Type of this accelerator.

395

},

396

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

397

"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.

398

"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

399

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

400

"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

2021-08-17 00:20:40 -0700

[diff] [blame]

401

"jobType": "A String", # The type of Job to be used on this execution.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

402

"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.

403

"a_key": "A String",

404

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

405

"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).

406

"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

2021-03-02 11:49:08 -0800

[diff] [blame]

407

"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.

408

"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

2021-07-20 00:20:24 -0700

[diff] [blame]

409

"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

2021-04-13 14:47:53 -0400

[diff] [blame]

410

"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

2021-09-21 00:22:28 -0700

[diff] [blame]

411

"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.

412

"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.

413

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

414

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

415

"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

416

"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`

yoshi-code-bot