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

<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

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

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

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

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets details of schedule</p>

89

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

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

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

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

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

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

116

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

117

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

118

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

119

"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.

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

124

"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

125

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

126

"a_key": "A String",

127

},

128

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

129

"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

130

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

131

"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

132

"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.

Anthonios Partheniou

10f4b67

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

[diff] [blame^]

133

"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

b6dc1b9

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

[diff] [blame]

134

},

135

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

136

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

137

{ # The definition of a single executed notebook.

138

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

139

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

140

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

141

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

142

"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.

143

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

144

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

145

},

146

"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

147

"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

148

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

149

"a_key": "A String",

150

},

151

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

152

"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

153

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

154

"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

155

"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.

Anthonios Partheniou

10f4b67

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

[diff] [blame^]

156

"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

b6dc1b9

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

[diff] [blame]

157

},

158

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

159

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

160

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

161

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

166

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

167

}

168

169

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

170

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

177

178

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

179

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

180

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

181

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

182

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

183

{

184

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

185

},

186

],

187

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

188

},

189

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

190

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

191

},

192

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

193

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

194

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

201

<pre>Deletes schedule and all underlying jobs

202

203

Args:

204

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

205

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

212

213

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

214

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

215

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

216

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

217

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

218

{

219

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

220

},

221

],

222

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

223

},

224

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

225

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

226

},

227

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

228

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

229

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

236

<pre>Gets details of schedule

237

238

Args:

239

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

240

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

247

248

{ # The definition of a schedule.

249

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

250

"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

251

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

252

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

253

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

254

"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.

255

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

256

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

257

},

258

"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

259

"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

260

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

261

"a_key": "A String",

262

},

263

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

264

"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

265

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

266

"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

267

"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.

Anthonios Partheniou

10f4b67

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

[diff] [blame^]

268

"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

b6dc1b9

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

[diff] [blame]

269

},

270

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

271

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

272

{ # The definition of a single executed notebook.

273

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

274

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

275

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

276

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

277

"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.

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

282

"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

283

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

284

"a_key": "A String",

285

},

286

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

287

"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

288

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

289

"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

290

"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.

Anthonios Partheniou

10f4b67

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

[diff] [blame^]

291

"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

b6dc1b9

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

[diff] [blame]

292

},

293

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

294

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

295

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

296

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

301

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

307

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

308

309

Args:

310

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

311

filter: string, Filter applied to resulting schedules.

312

orderBy: string, Field to order results by.

313

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

314

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

315

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

322

323

{ # Response for listing scheduled notebook job.

324

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

325

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

326

{ # The definition of a schedule.

327

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

328

"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

329

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

330

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

331

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

332

"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.

333

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

334

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

335

},

336

"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

337

"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

338

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

339

"a_key": "A String",

340

},

341

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

342

"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

343

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

344

"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

345

"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.

Anthonios Partheniou

10f4b67

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

[diff] [blame^]

346

"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

b6dc1b9

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

[diff] [blame]

347

},

348

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

349

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

350

{ # The definition of a single executed notebook.

351

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

352

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

353

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

354

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

355

"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.

356

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

357

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

358

},

359

"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

360

"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

361

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

362

"a_key": "A String",

363

},

364

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

365

"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

366

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

367

"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

368

"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.

Anthonios Partheniou

10f4b67

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

[diff] [blame^]

369

"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

b6dc1b9

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

[diff] [blame]

370

},

371

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

372

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

373

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

374

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

379

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

380

},

381

],

382

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

"A String",

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

390

<pre>Retrieves the next page of results.

391

392

Args:

393

previous_request: The request for the previous page. (required)

394

previous_response: The response from the request for the previous page. (required)

395

396

Returns:

397

A request object that you can call 'execute()' on to request the next

398

page. Returns None if there are no more items in the collection.

</pre>

</div>

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

404

<pre>Triggers execution of an existing schedule.

405

406

Args:

407

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

408

body: object, The request body.

409

The object takes the form of:

410

411

{ # Request for created scheduled notebooks

412

}

413

414

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

421

422

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

423

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

424

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

425

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

426

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

427

{

428

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

429

},

430

],

431

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

432

},

433

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

434

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

435

},

436

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

437

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

438

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

},

}</pre>

</div>

</body></html>