@googleapis/notebooks
Version:
1,018 lines (1,009 loc) • 435 kB
text/typescript
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */
/* eslint-disable no-irregular-whitespace */
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosResponseWithHTTP2,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace notebooks_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Notebooks API
*
* Notebooks API is used to manage notebook resources in Google Cloud.
*
* @example
* ```js
* const {google} = require('googleapis');
* const notebooks = google.notebooks('v1');
* ```
*/
export class Notebooks {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.projects = new Resource$Projects(this.context);
}
}
/**
* Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.
*/
export interface Schema$AcceleratorConfig {
/**
* Count of cores of this accelerator.
*/
coreCount?: string | null;
/**
* Type of this accelerator.
*/
type?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
*/
export interface Schema$BootImage {}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {}
/**
* Definition of a container image for starting a notebook instance with the environment installed in a container.
*/
export interface Schema$ContainerImage {
/**
* Required. The path to the container image repository. For example: `gcr.io/{project_id\}/{image_name\}`
*/
repository?: string | null;
/**
* The tag of the container image. If not specified, this defaults to the latest tag.
*/
tag?: string | null;
}
/**
* Parameters used in Dataproc JobType executions.
*/
export interface Schema$DataprocParameters {
/**
* URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID\}/regions/{REGION\}/clusters/{CLUSTER_NAME\}`
*/
cluster?: string | null;
}
/**
* Request for creating a notebook instance diagnostic file.
*/
export interface Schema$DiagnoseInstanceRequest {
/**
* Required. Defines flags that are used to run the diagnostic tool
*/
diagnosticConfig?: Schema$DiagnosticConfig;
/**
* Optional. Maximum amount of time in minutes before the operation times out.
*/
timeoutMinutes?: number | null;
}
/**
* Request for creating a notebook instance diagnostic file.
*/
export interface Schema$DiagnoseRuntimeRequest {
/**
* Required. Defines flags that are used to run the diagnostic tool
*/
diagnosticConfig?: Schema$DiagnosticConfig;
/**
* Optional. Maximum amount of time in minutes before the operation times out.
*/
timeoutMinutes?: number | null;
}
/**
* Defines flags that are used to run the diagnostic tool
*/
export interface Schema$DiagnosticConfig {
/**
* Optional. Enables flag to copy all `/home/jupyter` folder contents
*/
copyHomeFilesFlagEnabled?: boolean | null;
/**
* Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix (`gs://$GCS_BUCKET`). Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
*/
gcsBucket?: string | null;
/**
* Optional. Enables flag to capture packets from the instance for 30 seconds
*/
packetCaptureFlagEnabled?: boolean | null;
/**
* Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
*/
relativePath?: string | null;
/**
* Optional. Enables flag to repair service for instance
*/
repairFlagEnabled?: boolean | null;
}
/**
* An instance-attached disk resource.
*/
export interface Schema$Disk {
/**
* Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
*/
autoDelete?: boolean | null;
/**
* Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
*/
boot?: boolean | null;
/**
* Indicates 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.
*/
deviceName?: string | null;
/**
* Indicates the size of the disk in base-2 GB.
*/
diskSizeGb?: string | null;
/**
* 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.
*/
guestOsFeatures?: Schema$GuestOsFeature[];
/**
* 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.
*/
index?: string | null;
/**
* Indicates 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`
*/
interface?: string | null;
/**
* Type of the resource. Always compute#attachedDisk for attached disks.
*/
kind?: string | null;
/**
* A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
*/
licenses?: string[] | null;
/**
* 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`
*/
mode?: string | null;
/**
* Indicates a valid partial or full URL to an existing Persistent Disk resource.
*/
source?: string | null;
/**
* Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`. Valid values: * `PERSISTENT` * `SCRATCH`
*/
type?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {}
/**
* Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
*/
export interface Schema$EncryptionConfig {
/**
* 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\}`
*/
kmsKey?: string | null;
}
/**
* Definition of a software environment that is used to start a notebook instance.
*/
export interface Schema$Environment {
/**
* Use a container image to start the notebook instance.
*/
containerImage?: Schema$ContainerImage;
/**
* Output only. The time at which this environment was created.
*/
createTime?: string | null;
/**
* A brief description of this environment.
*/
description?: string | null;
/**
* Display name of this environment for the UI.
*/
displayName?: string | null;
/**
* Output only. Name of this environment. Format: `projects/{project_id\}/locations/{location\}/environments/{environment_id\}`
*/
name?: string | null;
/**
* 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. Example: `"gs://path-to-file/file-name"`
*/
postStartupScript?: string | null;
/**
* Use a Compute Engine VM image to start the notebook instance.
*/
vmImage?: Schema$VmImage;
}
/**
* The definition of an Event for a managed / semi-managed notebook instance.
*/
export interface Schema$Event {
/**
* Optional. Event details. This field is used to pass event information.
*/
details?: {[key: string]: string} | null;
/**
* Event report time.
*/
reportTime?: string | null;
/**
* Event type.
*/
type?: string | null;
}
/**
* The definition of a single executed notebook.
*/
export interface Schema$Execution {
/**
* Output only. Time the Execution was instantiated.
*/
createTime?: string | null;
/**
* A brief description of this execution.
*/
description?: string | null;
/**
* Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
*/
displayName?: string | null;
/**
* execute metadata including name, hardware spec, region, labels, etc.
*/
executionTemplate?: Schema$ExecutionTemplate;
/**
* Output only. The URI of the external job used to execute the notebook.
*/
jobUri?: string | null;
/**
* Output only. The resource name of the execute. Format: `projects/{project_id\}/locations/{location\}/executions/{execution_id\}`
*/
name?: string | null;
/**
* Output notebook file generated by this execution
*/
outputNotebookFile?: string | null;
/**
* Output only. State of the underlying AI Platform job.
*/
state?: string | null;
/**
* Output only. Time the Execution was last updated.
*/
updateTime?: string | null;
}
/**
* The description a notebook execution workload.
*/
export interface Schema$ExecutionTemplate {
/**
* Configuration (count and accelerator type) for hardware running notebook execution.
*/
acceleratorConfig?: Schema$SchedulerAcceleratorConfig;
/**
* 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
*/
containerImageUri?: string | null;
/**
* Parameters used in Dataproc JobType executions.
*/
dataprocParameters?: Schema$DataprocParameters;
/**
* Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name\}/{folder\}/{notebook_file_name\}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
*/
inputNotebookFile?: string | null;
/**
* The type of Job to be used on this execution.
*/
jobType?: string | null;
/**
* Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
*/
kernelSpec?: string | null;
/**
* 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.
*/
labels?: {[key: string]: string} | null;
/**
* Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
*/
masterType?: string | null;
/**
* Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: `gs://{bucket_name\}/{folder\}` Ex: `gs://notebook_user/scheduled_notebooks`
*/
outputNotebookFolder?: string | null;
/**
* Parameters used within the 'input_notebook_file' notebook.
*/
parameters?: string | null;
/**
* 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`
*/
paramsYamlFile?: string | null;
/**
* Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
*/
scaleTier?: string | null;
/**
* 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.
*/
serviceAccount?: string | null;
/**
* The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`
*/
tensorboard?: string | null;
/**
* Parameters used in Vertex AI JobType executions.
*/
vertexAiParameters?: Schema$VertexAIParameters;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Response for checking if a notebook instance is healthy.
*/
export interface Schema$GetInstanceHealthResponse {
/**
* Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" \}
*/
healthInfo?: {[key: string]: string} | null;
/**
* Output only. Runtime health_state.
*/
healthState?: string | null;
}
/**
* Guest OS features for boot disk.
*/
export interface Schema$GuestOsFeature {
/**
* The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` * `SECURE_BOOT` * `UEFI_COMPATIBLE` * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`
*/
type?: string | null;
}
/**
* The definition of a notebook instance.
*/
export interface Schema$Instance {
/**
* The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
*/
acceleratorConfig?: Schema$AcceleratorConfig;
/**
* Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
*/
bootDiskSizeGb?: string | null;
/**
* Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
*/
bootDiskType?: string | null;
/**
* Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
*/
canIpForward?: boolean | null;
/**
* Use a container image to start the notebook instance.
*/
containerImage?: Schema$ContainerImage;
/**
* Output only. Instance creation time.
*/
createTime?: string | null;
/**
* Output only. Email address of entity that sent original CreateInstance request.
*/
creator?: string | null;
/**
* Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
*/
customGpuDriverPath?: string | null;
/**
* Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
*/
dataDiskSizeGb?: string | null;
/**
* Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
*/
dataDiskType?: string | null;
/**
* Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
*/
diskEncryption?: string | null;
/**
* Output only. Attached disks to notebook instance.
*/
disks?: Schema$Disk[];
/**
* Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
*/
installGpuDriver?: boolean | null;
/**
* Output only. Checks how feasible a migration from UmN to WbI is.
*/
instanceMigrationEligibility?: Schema$InstanceMigrationEligibility;
/**
* Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
*/
instanceOwners?: string[] | null;
/**
* Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id\}/locations/{location\}/keyRings/{key_ring_id\}/cryptoKeys/{key_id\}` Learn more about [using your own encryption keys](/kms/docs/quickstart).
*/
kmsKey?: string | null;
/**
* Labels to apply to this instance. These can be later modified by the setLabels method.
*/
labels?: {[key: string]: string} | null;
/**
* Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource) of this instance.
*/
machineType?: string | null;
/**
* Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `"--metadata=gcs-data-bucket=BUCKET"`.
*/
metadata?: {[key: string]: string} | null;
/**
* Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
*/
migrated?: boolean | null;
/**
* Output only. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
*/
name?: string | null;
/**
* The name of the VPC that this instance is in. Format: `projects/{project_id\}/global/networks/{network_id\}`
*/
network?: string | null;
/**
* Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
*/
nicType?: string | null;
/**
* If true, the notebook instance will not register with the proxy.
*/
noProxyAccess?: boolean | null;
/**
* If true, no external IP will be assigned to this instance.
*/
noPublicIp?: boolean | null;
/**
* Input only. If true, the data disk will not be auto deleted when deleting the instance.
*/
noRemoveDataDisk?: boolean | null;
/**
* 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`).
*/
postStartupScript?: string | null;
/**
* Output only. The proxy endpoint that is used to access the Jupyter notebook.
*/
proxyUri?: string | null;
/**
* Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
*/
reservationAffinity?: Schema$ReservationAffinity;
/**
* The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
*/
serviceAccount?: string | null;
/**
* Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
*/
serviceAccountScopes?: string[] | null;
/**
* Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
*/
shieldedInstanceConfig?: Schema$ShieldedInstanceConfig;
/**
* Output only. The state of this instance.
*/
state?: string | null;
/**
* The name of the subnet that this instance is in. Format: `projects/{project_id\}/regions/{region\}/subnetworks/{subnetwork_id\}`
*/
subnet?: string | null;
/**
* Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
*/
tags?: string[] | null;
/**
* Output only. Instance update time.
*/
updateTime?: string | null;
/**
* The upgrade history of this instance.
*/
upgradeHistory?: Schema$UpgradeHistoryEntry[];
/**
* Use a Compute Engine VM image to start the notebook instance.
*/
vmImage?: Schema$VmImage;
}
/**
* Notebook instance configurations that can be updated.
*/
export interface Schema$InstanceConfig {
/**
* Verifies core internal services are running.
*/
enableHealthMonitoring?: boolean | null;
/**
* Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
*/
notebookUpgradeSchedule?: string | null;
}
/**
* InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.
*/
export interface Schema$InstanceMigrationEligibility {
/**
* Output only. Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
*/
errors?: string[] | null;
/**
* Output only. Certain configurations will be defaulted during the migration.
*/
warnings?: string[] | null;
}
/**
* Response for checking if a notebook instance is upgradeable.
*/
export interface Schema$IsInstanceUpgradeableResponse {
/**
* If an instance is upgradeable.
*/
upgradeable?: boolean | null;
/**
* The new image self link this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true.
*/
upgradeImage?: string | null;
/**
* Additional information about upgrade.
*/
upgradeInfo?: string | null;
/**
* The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true.
*/
upgradeVersion?: string | null;
}
/**
* Response for listing environments.
*/
export interface Schema$ListEnvironmentsResponse {
/**
* A list of returned environments.
*/
environments?: Schema$Environment[];
/**
* A page token that can be used to continue listing from the last result in the next list call.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response for listing scheduled notebook executions
*/
export interface Schema$ListExecutionsResponse {
/**
* A list of returned instances.
*/
executions?: Schema$Execution[];
/**
* Page token that can be used to continue listing from the last result in the next list call.
*/
nextPageToken?: string | null;
/**
* Executions IDs that could not be reached. For example: ['projects/{project_id\}/location/{location\}/executions/imagenet_test1', 'projects/{project_id\}/location/{location\}/executions/classifier_train1']
*/
unreachable?: string[] | null;
}
/**
* Response for listing notebook instances.
*/
export interface Schema$ListInstancesResponse {
/**
* A list of returned instances.
*/
instances?: Schema$Instance[];
/**
* Page token that can be used to continue listing from the last result in the next list call.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached. For example, `['us-west1-a', 'us-central1-b']`. A ListInstancesResponse will only contain either instances or unreachables,
*/
unreachable?: string[] | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response for listing Managed Notebook Runtimes.
*/
export interface Schema$ListRuntimesResponse {
/**
* Page token that can be used to continue listing from the last result in the next list call.
*/
nextPageToken?: string | null;
/**
* A list of returned Runtimes.
*/
runtimes?: Schema$Runtime[];
/**
* Locations that could not be reached. For example, `['us-west1', 'us-central1']`. A ListRuntimesResponse will only contain either runtimes or unreachables,
*/
unreachable?: string[] | null;
}
/**
* Response for listing scheduled notebook job.
*/
export interface Schema$ListSchedulesResponse {
/**
* Page token that can be used to continue listing from the last result in the next list call.
*/
nextPageToken?: string | null;
/**
* A list of returned instances.
*/
schedules?: Schema$Schedule[];
/**
* Schedules that could not be reached. For example: ['projects/{project_id\}/location/{location\}/schedules/monthly_digest', 'projects/{project_id\}/location/{location\}/schedules/weekly_sentiment']
*/
unreachable?: string[] | null;
}
/**
* A Local attached disk resource.
*/
export interface Schema$LocalDisk {
/**
* 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).
*/
autoDelete?: boolean | null;
/**
* 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.
*/
boot?: boolean | null;
/**
* 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.
*/
deviceName?: string | null;
/**
* 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.
*/
guestOsFeatures?: Schema$RuntimeGuestOsFeature[];
/**
* 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.
*/
index?: number | null;
/**
* 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.
*/
initializeParams?: Schema$LocalDiskInitializeParams;
/**
* 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`
*/
interface?: string | null;
/**
* Output only. Type of the resource. Always compute#attachedDisk for attached disks.
*/
kind?: string | null;
/**
* Output only. Any valid publicly visible licenses.
*/
licenses?: string[] | null;
/**
* 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`
*/
mode?: string | null;
/**
* Specifies a valid partial or full URL to an existing Persistent Disk resource.
*/
source?: string | null;
/**
* Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not specified, the default is `PERSISTENT`. Valid values: * `PERSISTENT` * `SCRATCH`
*/
type?: string | null;
}
/**
* 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.
*/
export interface Schema$LocalDiskInitializeParams {
/**
* Optional. Provide this property when creating the disk.
*/
description?: string | null;
/**
* 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.
*/
diskName?: string | null;
/**
* 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.
*/
diskSizeGb?: string | null;
/**
* Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
*/
diskType?: string | null;
/**
* 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.
*/
labels?: {[key: string]: string} | null;
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {[key: string]: string} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {[key: string]: any} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* Request for migrating a User-Managed Notebook to Workbench Instances.
*/
export interface Schema$MigrateInstanceRequest {
/**
* Optional. Specifies the behavior of post startup script during migration.
*/
postStartupScriptOption?: string | null;
}
/**
* Request for migrating a Runtime to a Workbench Instance.
*/
export interface Schema$MigrateRuntimeRequest {
/**
* Optional. Name of the VPC that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same VPC, and this field must be empty. Format: `projects/{project_id\}/global/networks/{network_id\}`
*/
network?: string | null;
/**
* Optional. Specifies the behavior of post startup script during migration.
*/
postStartupScriptOption?: string | null;
/**
* Optional. Idempotent request UUID.
*/
requestId?: string | null;
/**
* Optional. The service account to be included in the Compute Engine instance of the new Workbench Instance when the Runtime uses "single user only" mode for permission. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. When the Runtime uses service account mode for permission, it will reuse the same service account, and this field must be empty.
*/
serviceAccount?: string | null;
/**
* Optional. Name of the subnet that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same subnet, and this field must be empty. Format: `projects/{project_id\}/regions/{region\}/subnetworks/{subnetwork_id\}`
*/
subnet?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: {[key: string]: any} | null;
/**
* 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\}`.
*/
name?: string | null;
/**
* The normal, successful response of the operation. 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`.
*/
response?: {[key: string]: any} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* API version used to start the operation.
*/
apiVersion?: string | null;
/**
* The time the operation was created.
*/
createTime?: string | null;
/**
* API endpoint name of this operation.
*/
endpoint?: string | null;
/**
* The time the operation finished running.
*/
endTime?: string | null;
/**
* Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
*/
requestedCancellation?: boolean | null;
/**
* Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.co