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

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

[diff] [blame]

96

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

97

<p class="firstline">Report and process a runtime event.</p>

98

Anthonios Partheniou

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

[diff] [blame]

99

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

100

<p class="firstline">Resets a Managed Notebook Runtime.</p>

101

102

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

103

<p class="firstline">Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance</p>

104

105

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

106

<p class="firstline">Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance</p>

107

108

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

109

<p class="firstline">Switch a Managed Notebook Runtime.</p>

110

<h3>Method Details</h3>

111

112

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

113

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, runtimeId=None, x__xgafv=None)</code>

118

<pre>Creates a new Runtime in a given project and location.

119

120

Args:

121

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

122

body: object, The request body.

123

The object takes the form of:

124

125

{ # The definition of a Runtime for a managed notebook instance.

126

"accessConfig": { # Specifies the login configuration for Runtime # The config settings for accessing runtime.

127

"accessType": "A String", # The type of access mode this instance.

128

"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the runtime.

129

"runtimeOwner": "A String", # The owner of this runtime after creation. Format: `alias@example.com` Currently supports one owner only.

130

},

131

"createTime": "A String", # Output only. Runtime creation time.

132

"healthState": "A String", # Output only. Runtime health_state.

133

"metrics": { # Contains runtime daemon metrics, such as OS and kernels and sessions stats. # Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.

134

"systemMetrics": { # Output only. The system metrics.

135

"a_key": "A String",

136

},

137

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

138

"name": "A String", # Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

139

"softwareConfig": { # Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `report-system-health: true` # The config settings for software inside the runtime.

Anthonios Partheniou

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

[diff] [blame]

140

"customGpuDriverPath": "A String", # Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

141

"enableHealthMonitoring": True or False, # Verifies core internal services are running. Default: True

yoshi-code-bot

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

[diff] [blame]

142

"idleShutdown": True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True

143

"idleShutdownTimeout": 42, # Time in minutes to wait before shuting down runtime. Default: 180 minutes

Anthonios Partheniou

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

[diff] [blame]

144

"installGpuDriver": True or False, # Install Nvidia Driver automatically.

145

"notebookUpgradeSchedule": "A String", # Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).

146

"postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

147

},

148

"state": "A String", # Output only. Runtime state.

149

"updateTime": "A String", # Output only. Runtime update time.

150

"virtualMachine": { # Runtime using Virtual Machine for computing. # Use a Compute Engine VM image to start the managed notebook instance.

151

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance.

152

"instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance.

153

"virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings.

154

"acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime.

155

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

156

"type": "A String", # Accelerator model.

157

},

158

"containerImages": [ # Optional. Use a list of container images to start the notebook instance.

159

{ # Definition of a container image for starting a notebook instance with the environment installed in a container.

160

"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`

161

"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.

162

},

163

],

164

"dataDisk": { # An Local attached disk resource. # Required. Data disk option configuration settings.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

165

"autoDelete": True or False, # Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

166

"boot": True or False, # Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

167

"deviceName": "A String", # Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Anthonios Partheniou

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

[diff] [blame]

168

"guestOsFeatures": [ # Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

169

{ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features for boot disk.

170

"type": "A String", # The ID of a supported feature. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS

Anthonios Partheniou

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

[diff] [blame]

171

},

172

],

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

173

"index": 42, # Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

174

"initializeParams": { # Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Anthonios Partheniou

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

[diff] [blame]

175

"description": "A String", # Optional. Provide this property when creating the disk.

176

"diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

177

"diskSizeGb": "A String", # Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.

178

"diskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).

179

"labels": { # Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

"a_key": "A String",

},

},

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: NVME SCSI

184

"kind": "A String", # Output only. Type of the resource. Always compute#attachedDisk for attached disks.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

185

"licenses": [ # Output only. Any valid publicly visible licenses.

Anthonios Partheniou

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

[diff] [blame]

186

"A String",

187

],

188

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: READ_ONLY READ_WRITE

189

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource.

190

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values: PERSISTENT SCRATCH

191

},

192

"encryptionConfig": { # Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine. # Optional. Encryption settings for virtual machine data disk.

193

"kmsKey": "A String", # The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`

194

},

195

"guestAttributes": { # Output only. The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).

196

"a_key": "A String",

197

},

198

"internalIpOnly": True or False, # Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

199

"labels": { # Optional. The labels to associate with this runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

200

"a_key": "A String",

201

},

202

"machineType": "A String", # Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`

203

"metadata": { # Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

204

"a_key": "A String",

205

},

206

"network": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` * `projects/[project_id]/regions/global/default` Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.

207

"nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

208

"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid. # Optional. Shielded VM Instance configuration settings.

Anthonios Partheniou

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

[diff] [blame]

209

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

210

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

211

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

212

},

213

"subnet": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0` * `projects/[project_id]/regions/us-east1/subnetworks/sub0`

214

"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

215

"A String",

216

],

217

"zone": "A String", # Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example: * `us-central1-b`

},

},

}

runtimeId: string, Required. User-defined unique ID of this Runtime.

223

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

230

231

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

232

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

233

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

234

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

235

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

236

{

237

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

238

},

239

],

240

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

241

},

242

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

243

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

244

},

245

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

246

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

247

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

254

<pre>Deletes a single Runtime.

255

256

Args:

257

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

258

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

265

266

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

267

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

268

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

269

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

270

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

271

{

272

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

273

},

274

],

275

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

276

},

277

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

278

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

279

},

280

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

281

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

282

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

289

<pre>Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

290

291

Args:

292

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

293

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

300

301

{ # The definition of a Runtime for a managed notebook instance.

302

"accessConfig": { # Specifies the login configuration for Runtime # The config settings for accessing runtime.

303

"accessType": "A String", # The type of access mode this instance.

304

"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the runtime.

305

"runtimeOwner": "A String", # The owner of this runtime after creation. Format: `alias@example.com` Currently supports one owner only.

306

},

307

"createTime": "A String", # Output only. Runtime creation time.

308

"healthState": "A String", # Output only. Runtime health_state.

309

"metrics": { # Contains runtime daemon metrics, such as OS and kernels and sessions stats. # Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.

310

"systemMetrics": { # Output only. The system metrics.

311

"a_key": "A String",

312

},

313

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

314

"name": "A String", # Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

315

"softwareConfig": { # Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `report-system-health: true` # The config settings for software inside the runtime.

Anthonios Partheniou

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

[diff] [blame]

316

"customGpuDriverPath": "A String", # Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

317

"enableHealthMonitoring": True or False, # Verifies core internal services are running. Default: True

yoshi-code-bot

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

[diff] [blame]

318

"idleShutdown": True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True

319

"idleShutdownTimeout": 42, # Time in minutes to wait before shuting down runtime. Default: 180 minutes

Anthonios Partheniou

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

[diff] [blame]

320

"installGpuDriver": True or False, # Install Nvidia Driver automatically.

321

"notebookUpgradeSchedule": "A String", # Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).

322

"postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

323

},

324

"state": "A String", # Output only. Runtime state.

325

"updateTime": "A String", # Output only. Runtime update time.

326

"virtualMachine": { # Runtime using Virtual Machine for computing. # Use a Compute Engine VM image to start the managed notebook instance.

327

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance.

328

"instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance.

329

"virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings.

330

"acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime.

331

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

332

"type": "A String", # Accelerator model.

333

},

334

"containerImages": [ # Optional. Use a list of container images to start the notebook instance.

335

{ # Definition of a container image for starting a notebook instance with the environment installed in a container.

336

"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`

337

"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.

338

},

339

],

340

"dataDisk": { # An Local attached disk resource. # Required. Data disk option configuration settings.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

341

"autoDelete": True or False, # Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

342

"boot": True or False, # Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

343

"deviceName": "A String", # Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Anthonios Partheniou

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

[diff] [blame]

344

"guestOsFeatures": [ # Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

345

{ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features for boot disk.

346

"type": "A String", # The ID of a supported feature. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS

Anthonios Partheniou

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

[diff] [blame]

347

},

348

],

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

349

"index": 42, # Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

350

"initializeParams": { # Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Anthonios Partheniou

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

[diff] [blame]

351

"description": "A String", # Optional. Provide this property when creating the disk.

352

"diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

353

"diskSizeGb": "A String", # Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.

354

"diskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).

355

"labels": { # Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

"a_key": "A String",

},

},

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: NVME SCSI

360

"kind": "A String", # Output only. Type of the resource. Always compute#attachedDisk for attached disks.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

361

"licenses": [ # Output only. Any valid publicly visible licenses.

Anthonios Partheniou

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

[diff] [blame]

362

"A String",

363

],

364

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: READ_ONLY READ_WRITE

365

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource.

366

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values: PERSISTENT SCRATCH

367

},

368

"encryptionConfig": { # Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine. # Optional. Encryption settings for virtual machine data disk.

369

"kmsKey": "A String", # The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`

370

},

371

"guestAttributes": { # Output only. The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).

372

"a_key": "A String",

373

},

374

"internalIpOnly": True or False, # Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

375

"labels": { # Optional. The labels to associate with this runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

376

"a_key": "A String",

377

},

378

"machineType": "A String", # Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`

379

"metadata": { # Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

380

"a_key": "A String",

381

},

382

"network": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` * `projects/[project_id]/regions/global/default` Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.

383

"nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

384

"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid. # Optional. Shielded VM Instance configuration settings.

Anthonios Partheniou

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

[diff] [blame]

385

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

386

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

387

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

388

},

389

"subnet": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0` * `projects/[project_id]/regions/us-east1/subnetworks/sub0`

390

"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

391

"A String",

392

],

393

"zone": "A String", # Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example: * `us-central1-b`

},

},

}</pre>

</div>

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

401

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

402

403

Args:

404

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

405

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

406

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

407

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

414

415

{ # Response for listing Managed Notebook Runtimes.

416

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

417

"runtimes": [ # A list of returned Runtimes.

418

{ # The definition of a Runtime for a managed notebook instance.

419

"accessConfig": { # Specifies the login configuration for Runtime # The config settings for accessing runtime.

420

"accessType": "A String", # The type of access mode this instance.

421

"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the runtime.

422

"runtimeOwner": "A String", # The owner of this runtime after creation. Format: `alias@example.com` Currently supports one owner only.

423

},

424

"createTime": "A String", # Output only. Runtime creation time.

425

"healthState": "A String", # Output only. Runtime health_state.

426

"metrics": { # Contains runtime daemon metrics, such as OS and kernels and sessions stats. # Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.

427

"systemMetrics": { # Output only. The system metrics.

428

"a_key": "A String",

429

},

430

},

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

431

"name": "A String", # Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

432

"softwareConfig": { # Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `report-system-health: true` # The config settings for software inside the runtime.

Anthonios Partheniou

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

[diff] [blame]

433

"customGpuDriverPath": "A String", # Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

434

"enableHealthMonitoring": True or False, # Verifies core internal services are running. Default: True

yoshi-code-bot

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

[diff] [blame]

435

"idleShutdown": True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True

436

"idleShutdownTimeout": 42, # Time in minutes to wait before shuting down runtime. Default: 180 minutes

Anthonios Partheniou

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

[diff] [blame]

437

"installGpuDriver": True or False, # Install Nvidia Driver automatically.

438

"notebookUpgradeSchedule": "A String", # Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).

439

"postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

440

},

441

"state": "A String", # Output only. Runtime state.

442

"updateTime": "A String", # Output only. Runtime update time.

443

"virtualMachine": { # Runtime using Virtual Machine for computing. # Use a Compute Engine VM image to start the managed notebook instance.

444

"instanceId": "A String", # Output only. The unique identifier of the Managed Compute Engine instance.

445

"instanceName": "A String", # Output only. The user-friendly name of the Managed Compute Engine instance.

446

"virtualMachineConfig": { # The config settings for virtual machine. # Virtual Machine configuration settings.

447

"acceleratorConfig": { # Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100` # Optional. The Compute Engine accelerator configuration for this runtime.

448

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

449

"type": "A String", # Accelerator model.

450

},

451

"containerImages": [ # Optional. Use a list of container images to start the notebook instance.

452

{ # Definition of a container image for starting a notebook instance with the environment installed in a container.

453

"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`

454

"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.

455

},

456

],

457

"dataDisk": { # An Local attached disk resource. # Required. Data disk option configuration settings.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

458

"autoDelete": True or False, # Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

459

"boot": True or False, # Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

460

"deviceName": "A String", # Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Anthonios Partheniou

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

[diff] [blame]

461

"guestOsFeatures": [ # Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

462

{ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features for boot disk.

463

"type": "A String", # The ID of a supported feature. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS

Anthonios Partheniou

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

[diff] [blame]

464

},

465

],

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

466

"index": 42, # Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

467

"initializeParams": { # Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Anthonios Partheniou

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

[diff] [blame]

468

"description": "A String", # Optional. Provide this property when creating the disk.

469

"diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

470

"diskSizeGb": "A String", # Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.

471

"diskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).

472

"labels": { # Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

"a_key": "A String",

},

},

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: NVME SCSI

477

"kind": "A String", # Output only. Type of the resource. Always compute#attachedDisk for attached disks.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

478

"licenses": [ # Output only. Any valid publicly visible licenses.

Anthonios Partheniou

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

[diff] [blame]

479

"A String",

480

],

481

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: READ_ONLY READ_WRITE

482

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource.

483

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values: PERSISTENT SCRATCH

484

},

485

"encryptionConfig": { # Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine. # Optional. Encryption settings for virtual machine data disk.

486

"kmsKey": "A String", # The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`

487

},

488

"guestAttributes": { # Output only. The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).

489

"a_key": "A String",

490

},

491

"internalIpOnly": True or False, # Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

492

"labels": { # Optional. The labels to associate with this runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

493

"a_key": "A String",

494

},

495

"machineType": "A String", # Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`

496

"metadata": { # Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

497

"a_key": "A String",

498

},

499

"network": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` * `projects/[project_id]/regions/global/default` Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.

500

"nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-07-27 00:20:26 -0700

[diff] [blame]

501

"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid. # Optional. Shielded VM Instance configuration settings.

Anthonios Partheniou