diff options
Diffstat (limited to 'third_party/googleapis/google/cloud/notebooks/v1')
12 files changed, 0 insertions, 3696 deletions
diff --git a/third_party/googleapis/google/cloud/notebooks/v1/BUILD.bazel b/third_party/googleapis/google/cloud/notebooks/v1/BUILD.bazel deleted file mode 100644 index a9c117d..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/BUILD.bazel +++ /dev/null @@ -1,395 +0,0 @@ -# This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/rules_gapic/tree/master/bazel - -# Most of the manual changes to this file will be overwritten. -# It's **only** allowed to change the following rule attribute values: -# - names of *_gapic_assembly_* rules -# - certain parameters of *_gapic_library rules, including but not limited to: -# * extra_protoc_parameters -# * extra_protoc_file_parameters -# The complete list of preserved parameters can be found in the source code. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -############################################################################## -# Common -############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") - -proto_library( - name = "notebooks_proto", - srcs = [ - "environment.proto", - "event.proto", - "execution.proto", - "instance.proto", - "instance_config.proto", - "managed_service.proto", - "runtime.proto", - "schedule.proto", - "service.proto", - ], - deps = [ - "//google/api:annotations_proto", - "//google/api:client_proto", - "//google/api:field_behavior_proto", - "//google/api:resource_proto", - "//google/longrunning:operations_proto", - "@com_google_protobuf//:timestamp_proto", - ], -) - -proto_library_with_info( - name = "notebooks_proto_with_info", - deps = [ - ":notebooks_proto", - "//google/cloud:common_resources_proto", - "//google/cloud/location:location_proto", - ], -) - -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_gapic_library", - "java_gapic_test", - "java_grpc_library", - "java_proto_library", -) - -java_proto_library( - name = "notebooks_java_proto", - deps = [":notebooks_proto"], -) - -java_grpc_library( - name = "notebooks_java_grpc", - srcs = [":notebooks_proto"], - deps = [":notebooks_java_proto"], -) - -java_gapic_library( - name = "notebooks_java_gapic", - srcs = [":notebooks_proto_with_info"], - gapic_yaml = None, - grpc_service_config = "notebooks_grpc_service_config.json", - service_yaml = "notebooks_v1.yaml", - test_deps = [ - ":notebooks_java_grpc", - "//google/cloud/location:location_java_grpc", - ], - deps = [ - ":notebooks_java_proto", - "//google/api:api_java_proto", - "//google/cloud/location:location_java_grpc", - "//google/cloud/location:location_java_proto", - ], -) - -java_gapic_test( - name = "notebooks_java_gapic_test_suite", - test_classes = [ - "com.google.cloud.notebooks.v1.ManagedNotebookServiceClientTest", - "com.google.cloud.notebooks.v1.NotebookServiceClientTest", - ], - runtime_deps = [":notebooks_java_gapic_test"], -) - -# Open Source Packages -java_gapic_assembly_gradle_pkg( - name = "google-cloud-notebooks-v1-java", - include_samples = True, - deps = [ - ":notebooks_java_gapic", - ":notebooks_java_grpc", - ":notebooks_java_proto", - ":notebooks_proto", - "//google/cloud/location:location_java_grpc", - "//google/cloud/location:location_java_proto", - "//google/cloud/location:location_proto", - ], -) - -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - -go_proto_library( - name = "notebooks_go_proto", - compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/cloud/notebooks/v1", - protos = [":notebooks_proto"], - deps = [ - "//google/api:annotations_go_proto", - "//google/cloud/location:location_go_proto", - "//google/longrunning:longrunning_go_proto", - ], -) - -go_gapic_library( - name = "notebooks_go_gapic", - srcs = [":notebooks_proto_with_info"], - grpc_service_config = "notebooks_grpc_service_config.json", - importpath = "cloud.google.com/go/notebooks/apiv1;notebooks", - metadata = True, - service_yaml = "notebooks_v1.yaml", - deps = [ - ":notebooks_go_proto", - "//google/cloud/location:location_go_proto", - "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", - ], -) - -go_test( - name = "notebooks_go_gapic_test", - srcs = [":notebooks_go_gapic_srcjar_test"], - embed = [":notebooks_go_gapic"], - importpath = "cloud.google.com/go/notebooks/apiv1", -) - -# Open Source Packages -go_gapic_assembly_pkg( - name = "gapi-cloud-notebooks-v1-go", - deps = [ - ":notebooks_go_gapic", - ":notebooks_go_gapic_srcjar-metadata.srcjar", - ":notebooks_go_gapic_srcjar-test.srcjar", - ":notebooks_go_proto", - ], -) - -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - -py_gapic_library( - name = "notebooks_py_gapic", - srcs = [":notebooks_proto"], - grpc_service_config = "notebooks_grpc_service_config.json", - transport = "grpc", -) - -py_test( - name = "notebooks_py_gapic_test", - srcs = [ - "notebooks_py_gapic_pytest.py", - "notebooks_py_gapic_test.py", - ], - legacy_create_init = False, - deps = [":notebooks_py_gapic"], -) - -# Open Source Packages -py_gapic_assembly_pkg( - name = "notebooks-v1-py", - deps = [ - ":notebooks_py_gapic", - ], -) - -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_gapic_assembly_pkg", - "php_gapic_library", - "php_grpc_library", - "php_proto_library", -) - -php_proto_library( - name = "notebooks_php_proto", - deps = [":notebooks_proto"], -) - -php_grpc_library( - name = "notebooks_php_grpc", - srcs = [":notebooks_proto"], - deps = [":notebooks_php_proto"], -) - -php_gapic_library( - name = "notebooks_php_gapic", - srcs = [":notebooks_proto_with_info"], - grpc_service_config = "notebooks_grpc_service_config.json", - service_yaml = "notebooks_v1.yaml", - deps = [ - ":notebooks_php_grpc", - ":notebooks_php_proto", - ], -) - -# Open Source Packages -php_gapic_assembly_pkg( - name = "google-cloud-notebooks-v1-php", - deps = [ - ":notebooks_php_gapic", - ":notebooks_php_grpc", - ":notebooks_php_proto", - ], -) - -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - -nodejs_gapic_library( - name = "notebooks_nodejs_gapic", - package_name = "@google-cloud/notebooks", - src = ":notebooks_proto_with_info", - extra_protoc_parameters = ["metadata"], - grpc_service_config = "notebooks_grpc_service_config.json", - package = "google.cloud.notebooks.v1", - service_yaml = "notebooks_v1.yaml", - deps = [], -) - -nodejs_gapic_assembly_pkg( - name = "notebooks-v1-nodejs", - deps = [ - ":notebooks_nodejs_gapic", - ":notebooks_proto", - ], -) - -############################################################################## -# Ruby -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", - "ruby_grpc_library", - "ruby_proto_library", -) - -ruby_proto_library( - name = "notebooks_ruby_proto", - deps = [":notebooks_proto"], -) - -ruby_grpc_library( - name = "notebooks_ruby_grpc", - srcs = [":notebooks_proto"], - deps = [":notebooks_ruby_proto"], -) - -ruby_cloud_gapic_library( - name = "notebooks_ruby_gapic", - srcs = [":notebooks_proto"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-notebooks-v1", - "ruby-cloud-env-prefix=NOTEBOOKS", - "ruby-cloud-product-url=https://cloud.google.com/ai-platform-notebooks", - "ruby-cloud-api-id=notebooks.googleapis.com", - "ruby-cloud-api-shortname=notebooks", - ], - grpc_service_config = "notebooks_grpc_service_config.json", - ruby_cloud_description = "AI Platform Notebooks makes it easy to manage JupyterLab instances through a protected, publicly available notebook instance URL. A JupyterLab instance is a Deep Learning virtual machine instance with the latest machine learning and data science libraries pre-installed.", - ruby_cloud_title = "AI Platform Notebooks V1", - deps = [ - ":notebooks_ruby_grpc", - ":notebooks_ruby_proto", - ], -) - -# Open Source Packages -ruby_gapic_assembly_pkg( - name = "google-cloud-notebooks-v1-ruby", - deps = [ - ":notebooks_ruby_gapic", - ":notebooks_ruby_grpc", - ":notebooks_ruby_proto", - ], -) - -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_gapic_assembly_pkg", - "csharp_gapic_library", - "csharp_grpc_library", - "csharp_proto_library", -) - -csharp_proto_library( - name = "notebooks_csharp_proto", - deps = [":notebooks_proto"], -) - -csharp_grpc_library( - name = "notebooks_csharp_grpc", - srcs = [":notebooks_proto"], - deps = [":notebooks_csharp_proto"], -) - -csharp_gapic_library( - name = "notebooks_csharp_gapic", - srcs = [":notebooks_proto_with_info"], - common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "notebooks_grpc_service_config.json", - service_yaml = "notebooks_v1.yaml", - deps = [ - ":notebooks_csharp_grpc", - ":notebooks_csharp_proto", - ], -) - -# Open Source Packages -csharp_gapic_assembly_pkg( - name = "google-cloud-notebooks-v1-csharp", - deps = [ - ":notebooks_csharp_gapic", - ":notebooks_csharp_grpc", - ":notebooks_csharp_proto", - ], -) - -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - -cc_proto_library( - name = "notebooks_cc_proto", - deps = [":notebooks_proto"], -) - -cc_grpc_library( - name = "notebooks_cc_grpc", - srcs = [":notebooks_proto"], - grpc_only = True, - deps = [":notebooks_cc_proto"], -) diff --git a/third_party/googleapis/google/cloud/notebooks/v1/environment.proto b/third_party/googleapis/google/cloud/notebooks/v1/environment.proto deleted file mode 100644 index 1aff9ba..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/environment.proto +++ /dev/null @@ -1,96 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/timestamp.proto"; - -option csharp_namespace = "Google.Cloud.Notebooks.V1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "EnvironmentProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1"; -option ruby_package = "Google::Cloud::Notebooks::V1"; - -// Definition of a software environment that is used to start a notebook -// instance. -message Environment { - option (google.api.resource) = { - type: "notebooks.googleapis.com/Environment" - pattern: "projects/{project}/environments/{environment}" - }; - - // Output only. Name of this environment. - // Format: - // `projects/{project_id}/locations/{location}/environments/{environment_id}` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Display name of this environment for the UI. - string display_name = 2; - - // A brief description of this environment. - string description = 3; - - // Type of the environment; can be one of VM image, or container image. - oneof image_type { - // Use a Compute Engine VM image to start the notebook instance. - VmImage vm_image = 6; - - // Use a container image to start the notebook instance. - ContainerImage container_image = 7; - } - - // 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"` - string post_startup_script = 8; - - // Output only. The time at which this environment was created. - google.protobuf.Timestamp create_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Definition of a custom Compute Engine virtual machine image for starting a -// notebook instance with the environment installed directly on the VM. -message VmImage { - // Required. The name of the Google Cloud project that this VM image belongs to. - // Format: `{project_id}` - string project = 1 [(google.api.field_behavior) = REQUIRED]; - - // The reference to an external Compute Engine VM image. - oneof image { - // Use VM image name to find the image. - string image_name = 2; - - // Use this VM image family to find the image; the newest image in this - // family will be used. - string image_family = 3; - } -} - -// Definition of a container image for starting a notebook instance with the -// environment installed in a container. -message ContainerImage { - // Required. The path to the container image repository. For example: - // `gcr.io/{project_id}/{image_name}` - string repository = 1 [(google.api.field_behavior) = REQUIRED]; - - // The tag of the container image. If not specified, this defaults - // to the latest tag. - string tag = 2; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/event.proto b/third_party/googleapis/google/cloud/notebooks/v1/event.proto deleted file mode 100644 index bb0c91c..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/event.proto +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/field_behavior.proto"; -import "google/protobuf/timestamp.proto"; - -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "EventProto"; -option java_package = "com.google.cloud.notebooks.v1"; - -// The definition of an Event for a managed / semi-managed notebook instance. -message Event { - // The definition of the event types. - enum EventType { - // Event is not specified. - EVENT_TYPE_UNSPECIFIED = 0; - - // The instance / runtime is idle - IDLE = 1; - - // The instance / runtime is available. - // This event indicates that instance / runtime underlying compute is - // operational. - HEARTBEAT = 2; - - // The instance / runtime health is available. - // This event indicates that instance / runtime health information. - HEALTH = 3; - - // The instance / runtime is available. - // This event allows instance / runtime to send Host maintenance - // information to Control Plane. - // https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance - MAINTENANCE = 4; - } - - // Event report time. - google.protobuf.Timestamp report_time = 1; - - // Event type. - EventType type = 2; - - // Optional. Event details. This field is used to pass event information. - map<string, string> details = 3 [(google.api.field_behavior) = OPTIONAL]; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/execution.proto b/third_party/googleapis/google/cloud/notebooks/v1/execution.proto deleted file mode 100644 index 03940f3..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/execution.proto +++ /dev/null @@ -1,349 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/timestamp.proto"; - -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "ExecutionProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option (google.api.resource_definition) = { - type: "aiplatform.googleapis.com/Tensorboard" - pattern: "projects/{project}/locations/{location}/tensorboards/{tensorboard}" -}; - -// The description a notebook execution workload. -message ExecutionTemplate { - // Required. Specifies the machine types, the number of replicas for workers - // and parameter servers. - enum ScaleTier { - // Unspecified Scale Tier. - SCALE_TIER_UNSPECIFIED = 0; - - // A single worker instance. This tier is suitable for learning how to use - // Cloud ML, and for experimenting with new models using small datasets. - BASIC = 1; - - // Many workers and a few parameter servers. - STANDARD_1 = 2; - - // A large number of workers with many parameter servers. - PREMIUM_1 = 3; - - // A single worker instance with a K80 GPU. - BASIC_GPU = 4; - - // A single worker instance with a Cloud TPU. - BASIC_TPU = 5; - - // The CUSTOM tier is not a set tier, but rather enables you to use your - // own cluster specification. When you use this tier, set values to - // configure your processing cluster according to these guidelines: - // - // * You _must_ set `ExecutionTemplate.masterType` to specify the type - // of machine to use for your master node. This is the only required - // setting. - CUSTOM = 6; - } - - // Hardware accelerator types for AI Platform Training jobs. - enum SchedulerAcceleratorType { - // Unspecified accelerator type. Default to no GPU. - SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED = 0; - - // Nvidia Tesla K80 GPU. - NVIDIA_TESLA_K80 = 1; - - // Nvidia Tesla P100 GPU. - NVIDIA_TESLA_P100 = 2; - - // Nvidia Tesla V100 GPU. - NVIDIA_TESLA_V100 = 3; - - // Nvidia Tesla P4 GPU. - NVIDIA_TESLA_P4 = 4; - - // Nvidia Tesla T4 GPU. - NVIDIA_TESLA_T4 = 5; - - // Nvidia Tesla A100 GPU. - NVIDIA_TESLA_A100 = 10; - - // TPU v2. - TPU_V2 = 6; - - // TPU v3. - TPU_V3 = 7; - } - - // Definition of a hardware accelerator. Note that not all combinations - // of `type` and `core_count` are valid. Check [GPUs on - // Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid - // combination. TPUs are not supported. - message SchedulerAcceleratorConfig { - // Type of this accelerator. - SchedulerAcceleratorType type = 1; - - // Count of cores of this accelerator. - int64 core_count = 2; - } - - // The backend used for this execution. - enum JobType { - // No type specified. - JOB_TYPE_UNSPECIFIED = 0; - - // Custom Job in `aiplatform.googleapis.com`. - // Default value for an execution. - VERTEX_AI = 1; - - // Run execution on a cluster with Dataproc as a job. - // https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs - DATAPROC = 2; - } - - // Parameters used in Dataproc JobType executions. - message DataprocParameters { - // URI for cluster used to run Dataproc execution. - // Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}` - string cluster = 1; - } - - // Parameters used in Vertex AI JobType executions. - message VertexAIParameters { - // The full name of the Compute Engine - // [network](/compute/docs/networks-and-firewalls#networks) to which the Job - // should be peered. For example, `projects/12345/global/networks/myVPC`. - // [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) - // is of the form `projects/{project}/global/networks/{network}`. - // Where {project} is a project number, as in `12345`, and {network} is a - // network name. - // - // Private services access must already be configured for the network. If - // left unspecified, the job is not peered with any network. - string network = 1; - - // Environment variables. - // At most 100 environment variables can be specified and unique. - // Example: GCP_BUCKET=gs://my-bucket/samples/ - map<string, string> env = 2; - } - - // Required. Scale tier of the hardware used for notebook execution. - // DEPRECATED Will be discontinued. As right now only CUSTOM is supported. - ScaleTier scale_tier = 1 [ - deprecated = true, - (google.api.field_behavior) = REQUIRED - ]; - - // 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). - string master_type = 2; - - // Configuration (count and accelerator type) for hardware running notebook - // execution. - SchedulerAcceleratorConfig accelerator_config = 3; - - // 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. - map<string, string> labels = 4; - - // 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` - string input_notebook_file = 5; - - // 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 - string container_image_uri = 6; - - // 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` - string output_notebook_folder = 7; - - // 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` - string params_yaml_file = 8; - - // Parameters used within the 'input_notebook_file' notebook. - string parameters = 9; - - // 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. - string service_account = 10; - - // The type of Job to be used on this execution. - JobType job_type = 11; - - // Parameters for an execution type. - // NOTE: There are currently no extra parameters for VertexAI jobs. - oneof job_parameters { - // Parameters used in Dataproc JobType executions. - DataprocParameters dataproc_parameters = 12; - - // Parameters used in Vertex AI JobType executions. - VertexAIParameters vertex_ai_parameters = 13; - } - - // 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. - string kernel_spec = 14; - - // The name of a Vertex AI [Tensorboard] resource to which this execution - // will upload Tensorboard logs. - // Format: - // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` - string tensorboard = 15 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Tensorboard" - }]; -} - -// The definition of a single executed notebook. -message Execution { - option (google.api.resource) = { - type: "notebooks.googleapis.com/Execution" - pattern: "projects/{project}/location/{location}/executions/{execution}" - }; - - // Enum description of the state of the underlying AIP job. - enum State { - // The job state is unspecified. - STATE_UNSPECIFIED = 0; - - // The job has been just created and processing has not yet begun. - QUEUED = 1; - - // The service is preparing to execution the job. - PREPARING = 2; - - // The job is in progress. - RUNNING = 3; - - // The job completed successfully. - SUCCEEDED = 4; - - // The job failed. - // `error_message` should contain the details of the failure. - FAILED = 5; - - // The job is being cancelled. - // `error_message` should describe the reason for the cancellation. - CANCELLING = 6; - - // The job has been cancelled. - // `error_message` should describe the reason for the cancellation. - CANCELLED = 7; - - // The job has become expired (relevant to Vertex AI jobs) - // https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState - EXPIRED = 9; - - // The Execution is being created. - INITIALIZING = 10; - } - - // execute metadata including name, hardware spec, region, labels, etc. - ExecutionTemplate execution_template = 1; - - // Output only. The resource name of the execute. Format: - // `projects/{project_id}/locations/{location}/executions/{execution_id}` - string name = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Name used for UI purposes. - // Name can only contain alphanumeric characters and underscores '_'. - string display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // A brief description of this execution. - string description = 4; - - // Output only. Time the Execution was instantiated. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time the Execution was last updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. State of the underlying AI Platform job. - State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output notebook file generated by this execution - string output_notebook_file = 8; - - // Output only. The URI of the external job used to execute the notebook. - string job_uri = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/instance.proto b/third_party/googleapis/google/cloud/notebooks/v1/instance.proto deleted file mode 100644 index c759444..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/instance.proto +++ /dev/null @@ -1,540 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/notebooks/v1/environment.proto"; -import "google/protobuf/timestamp.proto"; - -option csharp_namespace = "Google.Cloud.Notebooks.V1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "InstanceProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1"; -option ruby_package = "Google::Cloud::Notebooks::V1"; - -// Reservation Affinity for consuming Zonal reservation. -message ReservationAffinity { - // Indicates whether to consume capacity from an reservation or not. - enum Type { - // Default type. - TYPE_UNSPECIFIED = 0; - - // Do not consume from any allocated capacity. - NO_RESERVATION = 1; - - // Consume any reservation available. - ANY_RESERVATION = 2; - - // Must consume from a specific reservation. Must specify key value fields - // for specifying the reservations. - SPECIFIC_RESERVATION = 3; - } - - // Optional. Type of reservation to consume - Type consume_reservation_type = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Corresponds to the label key of reservation resource. - string key = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Corresponds to the label values of reservation resource. - repeated string values = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The definition of a notebook instance. -message Instance { - option (google.api.resource) = { - type: "notebooks.googleapis.com/Instance" - pattern: "projects/{project}/instances/{instance}" - }; - - // Definition of the types of hardware accelerators that can be used on this - // instance. - enum AcceleratorType { - // Accelerator type is not specified. - ACCELERATOR_TYPE_UNSPECIFIED = 0; - - // Accelerator type is Nvidia Tesla K80. - NVIDIA_TESLA_K80 = 1; - - // Accelerator type is Nvidia Tesla P100. - NVIDIA_TESLA_P100 = 2; - - // Accelerator type is Nvidia Tesla V100. - NVIDIA_TESLA_V100 = 3; - - // Accelerator type is Nvidia Tesla P4. - NVIDIA_TESLA_P4 = 4; - - // Accelerator type is Nvidia Tesla T4. - NVIDIA_TESLA_T4 = 5; - - // Accelerator type is Nvidia Tesla A100. - NVIDIA_TESLA_A100 = 11; - - // Accelerator type is NVIDIA Tesla T4 Virtual Workstations. - NVIDIA_TESLA_T4_VWS = 8; - - // Accelerator type is NVIDIA Tesla P100 Virtual Workstations. - NVIDIA_TESLA_P100_VWS = 9; - - // Accelerator type is NVIDIA Tesla P4 Virtual Workstations. - NVIDIA_TESLA_P4_VWS = 10; - - // (Coming soon) Accelerator type is TPU V2. - TPU_V2 = 6; - - // (Coming soon) Accelerator type is TPU V3. - TPU_V3 = 7; - } - - // Definition of a hardware accelerator. Note that not all combinations - // of `type` and `core_count` are valid. Check [GPUs on - // Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid - // combination. TPUs are not supported. - message AcceleratorConfig { - // Type of this accelerator. - AcceleratorType type = 1; - - // Count of cores of this accelerator. - int64 core_count = 2; - } - - // The definition of the states of this instance. - enum State { - // State is not specified. - STATE_UNSPECIFIED = 0; - - // The control logic is starting the instance. - STARTING = 1; - - // The control logic is installing required frameworks and registering the - // instance with notebook proxy - PROVISIONING = 2; - - // The instance is running. - ACTIVE = 3; - - // The control logic is stopping the instance. - STOPPING = 4; - - // The instance is stopped. - STOPPED = 5; - - // The instance is deleted. - DELETED = 6; - - // The instance is upgrading. - UPGRADING = 7; - - // The instance is being created. - INITIALIZING = 8; - - // The instance is getting registered. - REGISTERING = 9; - - // The instance is suspending. - SUSPENDING = 10; - - // The instance is suspended. - SUSPENDED = 11; - } - - // Possible disk types for notebook instances. - enum DiskType { - // Disk type not set. - DISK_TYPE_UNSPECIFIED = 0; - - // Standard persistent disk type. - PD_STANDARD = 1; - - // SSD persistent disk type. - PD_SSD = 2; - - // Balanced persistent disk type. - PD_BALANCED = 3; - - // Extreme persistent disk type. - PD_EXTREME = 4; - } - - // Definition of the disk encryption options. - enum DiskEncryption { - // Disk encryption is not specified. - DISK_ENCRYPTION_UNSPECIFIED = 0; - - // Use Google managed encryption keys to encrypt the boot disk. - GMEK = 1; - - // Use customer managed encryption keys to encrypt the boot disk. - CMEK = 2; - } - - // An instance-attached disk resource. - message Disk { - // Guest OS features for boot disk. - message 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 - string type = 1; - } - - // Indicates whether the disk will be auto-deleted when the instance is - // deleted (but not when the disk is detached from the instance). - bool auto_delete = 1; - - // Indicates that this is a boot disk. The virtual machine will use the - // first partition of the disk for its root filesystem. - bool boot = 2; - - // 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. - string device_name = 3; - - // Indicates the size of the disk in base-2 GB. - int64 disk_size_gb = 4; - - // 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. - repeated GuestOsFeature guest_os_features = 5; - - // 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. - int64 index = 6; - - // 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 - string interface = 7; - - // Type of the resource. Always compute#attachedDisk for attached - // disks. - string kind = 8; - - // A list of publicly visible licenses. Reserved for Google's use. - // A License represents billing and aggregate usage data for public - // and marketplace images. - repeated string licenses = 9; - - // 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 - string mode = 10; - - // Indicates a valid partial or full URL to an existing Persistent Disk - // resource. - string source = 11; - - // Indicates the type of the disk, either SCRATCH or PERSISTENT. - // Valid values: - // - // * PERSISTENT - // * SCRATCH - string type = 12; - } - - // A set of Shielded Instance options. - // Check [Images using supported Shielded VM features] - // Not all combinations are valid. - message ShieldedInstanceConfig { - // 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. - bool enable_secure_boot = 1; - - // Defines whether the instance has the vTPM enabled. Enabled by default. - bool enable_vtpm = 2; - - // 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. - bool enable_integrity_monitoring = 3; - } - - // The entry of VM image upgrade history. - message UpgradeHistoryEntry { - // The definition of the states of this upgrade history entry. - enum State { - // State is not specified. - STATE_UNSPECIFIED = 0; - - // The instance upgrade is started. - STARTED = 1; - - // The instance upgrade is succeeded. - SUCCEEDED = 2; - - // The instance upgrade is failed. - FAILED = 3; - } - - // The definition of operations of this upgrade history entry. - enum Action { - // Operation is not specified. - ACTION_UNSPECIFIED = 0; - - // Upgrade. - UPGRADE = 1; - - // Rollback. - ROLLBACK = 2; - } - - // The snapshot of the boot disk of this notebook instance before upgrade. - string snapshot = 1; - - // The VM image before this instance upgrade. - string vm_image = 2; - - // The container image before this instance upgrade. - string container_image = 3; - - // The framework of this notebook instance. - string framework = 4; - - // The version of the notebook instance before this upgrade. - string version = 5; - - // The state of this instance upgrade history entry. - State state = 6; - - // The time that this instance upgrade history entry is created. - google.protobuf.Timestamp create_time = 7; - - // Target VM Image. Format: ainotebooks-vm/project/image-name/name. - string target_image = 8 [deprecated = true]; - - // Action. Rolloback or Upgrade. - Action action = 9; - - // Target VM Version, like m63. - string target_version = 10; - } - - // The type of vNIC driver. - // Default should be UNSPECIFIED_NIC_TYPE. - enum NicType { - // No type specified. - UNSPECIFIED_NIC_TYPE = 0; - - // VIRTIO - VIRTIO_NET = 1; - - // GVNIC - GVNIC = 2; - } - - // Output only. The name of this notebook instance. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Type of the environment; can be one of VM image, or container image. - oneof environment { - // Use a Compute Engine VM image to start the notebook instance. - VmImage vm_image = 2; - - // Use a container image to start the notebook instance. - ContainerImage container_image = 3; - } - - // 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`). - string post_startup_script = 4; - - // Output only. The proxy endpoint that is used to access the Jupyter notebook. - string proxy_uri = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - repeated string instance_owners = 6 [(google.api.field_behavior) = INPUT_ONLY]; - - // 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. - string service_account = 7; - - // 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 - repeated string service_account_scopes = 31 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The [Compute Engine machine type](/compute/docs/machine-types) of this - // instance. - string machine_type = 8 [(google.api.field_behavior) = REQUIRED]; - - // 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](/compute/docs/gpus/#gpus-list). - AcceleratorConfig accelerator_config = 9; - - // Output only. The state of this instance. - State state = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - bool install_gpu_driver = 11; - - // Specify a custom Cloud Storage path where the GPU driver is stored. - // If not specified, we'll automatically choose from official GPU drivers. - string custom_gpu_driver_path = 12; - - // Input only. The type of the boot disk attached to this instance, defaults to - // standard persistent disk (`PD_STANDARD`). - DiskType boot_disk_type = 13 [(google.api.field_behavior) = INPUT_ONLY]; - - // 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. - int64 boot_disk_size_gb = 14 [(google.api.field_behavior) = INPUT_ONLY]; - - // Input only. The type of the data disk attached to this instance, defaults to - // standard persistent disk (`PD_STANDARD`). - DiskType data_disk_type = 25 [(google.api.field_behavior) = INPUT_ONLY]; - - // 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. - int64 data_disk_size_gb = 26 [(google.api.field_behavior) = INPUT_ONLY]; - - // Input only. If true, the data disk will not be auto deleted when deleting the instance. - bool no_remove_data_disk = 27 [(google.api.field_behavior) = INPUT_ONLY]; - - // Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. - DiskEncryption disk_encryption = 15 [(google.api.field_behavior) = INPUT_ONLY]; - - // 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). - string kms_key = 16 [(google.api.field_behavior) = INPUT_ONLY]; - - // Output only. Attached disks to notebook instance. - repeated Disk disks = 28 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. Shielded VM configuration. - // [Images using supported Shielded VM - // features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). - ShieldedInstanceConfig shielded_instance_config = 30 [(google.api.field_behavior) = OPTIONAL]; - - // If true, no public IP will be assigned to this instance. - bool no_public_ip = 17; - - // If true, the notebook instance will not register with the proxy. - bool no_proxy_access = 18; - - // The name of the VPC that this instance is in. - // Format: - // `projects/{project_id}/global/networks/{network_id}` - string network = 19; - - // The name of the subnet that this instance is in. - // Format: - // `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - string subnet = 20; - - // Labels to apply to this instance. - // These can be later modified by the setLabels method. - map<string, string> labels = 21; - - // Custom metadata to apply to this instance. - map<string, string> metadata = 22; - - // Optional. The Compute Engine tags to add to runtime (see [Tagging - // instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). - repeated string tags = 32 [(google.api.field_behavior) = OPTIONAL]; - - // The upgrade history of this instance. - repeated UpgradeHistoryEntry upgrade_history = 29; - - // Optional. The type of vNIC to be used on this interface. This may be gVNIC or - // VirtioNet. - NicType nic_type = 33 [(google.api.field_behavior) = OPTIONAL]; - - // 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 reservation_affinity = 34 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. Email address of entity that sent original CreateInstance request. - string creator = 36 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. Flag to enable ip forwarding or not, default false/off. - // https://cloud.google.com/vpc/docs/using-routes#canipforward - bool can_ip_forward = 39 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. Instance creation time. - google.protobuf.Timestamp create_time = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Instance update time. - google.protobuf.Timestamp update_time = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/instance_config.proto b/third_party/googleapis/google/cloud/notebooks/v1/instance_config.proto deleted file mode 100644 index ebe67df..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/instance_config.proto +++ /dev/null @@ -1,35 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -option csharp_namespace = "Google.Cloud.Notebooks.V1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "InstanceConfigProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1"; -option ruby_package = "Google::Cloud::Notebooks::V1"; - -// Notebook instance configurations that can be updated. -message InstanceConfig { - // Cron expression in UTC timezone, used to schedule instance auto upgrade. - // Please follow the [cron format](https://en.wikipedia.org/wiki/Cron). - string notebook_upgrade_schedule = 1; - - // Verifies core internal services are running. - bool enable_health_monitoring = 2; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/managed_service.proto b/third_party/googleapis/google/cloud/notebooks/v1/managed_service.proto deleted file mode 100644 index 170ae98..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/managed_service.proto +++ /dev/null @@ -1,337 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/notebooks/v1/event.proto"; -import "google/cloud/notebooks/v1/runtime.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/timestamp.proto"; - -option csharp_namespace = "Google.Cloud.Notebooks.V1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "ManagedNotebooksProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1"; -option ruby_package = "Google::Cloud::Notebooks::V1"; - -// API v1 service for Managed Notebooks. -service ManagedNotebookService { - option (google.api.default_host) = "notebooks.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; - - // Lists Runtimes in a given project and location. - rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse) { - option (google.api.http) = { - get: "/v1/{parent=projects/*/locations/*}/runtimes" - }; - option (google.api.method_signature) = "parent"; - } - - // Gets details of a single Runtime. The location must be a regional endpoint - // rather than zonal. - rpc GetRuntime(GetRuntimeRequest) returns (Runtime) { - option (google.api.http) = { - get: "/v1/{name=projects/*/locations/*/runtimes/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Creates a new Runtime in a given project and location. - rpc CreateRuntime(CreateRuntimeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{parent=projects/*/locations/*}/runtimes" - body: "runtime" - }; - option (google.api.method_signature) = "parent,runtime_id,runtime"; - option (google.longrunning.operation_info) = { - response_type: "Runtime" - metadata_type: "OperationMetadata" - }; - } - - // Deletes a single Runtime. - rpc DeleteRuntime(DeleteRuntimeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - delete: "/v1/{name=projects/*/locations/*/runtimes/*}" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" - }; - } - - // 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 - rpc StartRuntime(StartRuntimeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/runtimes/*}:start" - body: "*" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "Runtime" - metadata_type: "OperationMetadata" - }; - } - - // 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 - rpc StopRuntime(StopRuntimeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/runtimes/*}:stop" - body: "*" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "Runtime" - metadata_type: "OperationMetadata" - }; - } - - // Switch a Managed Notebook Runtime. - rpc SwitchRuntime(SwitchRuntimeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/runtimes/*}:switch" - body: "*" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "Runtime" - metadata_type: "OperationMetadata" - }; - } - - // Resets a Managed Notebook Runtime. - rpc ResetRuntime(ResetRuntimeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/runtimes/*}:reset" - body: "*" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "Runtime" - metadata_type: "OperationMetadata" - }; - } - - // Report and process a runtime event. - rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/runtimes/*}:reportEvent" - body: "*" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "Runtime" - metadata_type: "OperationMetadata" - }; - } - - // Gets an access token for the consumer service account that the customer - // attached to the runtime. Only accessible from the tenant instance. - rpc RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest) returns (RefreshRuntimeTokenInternalResponse) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/runtimes/*}:refreshRuntimeTokenInternal" - body: "*" - }; - option (google.api.method_signature) = "name,vm_id"; - } -} - -// Request for listing Managed Notebook Runtimes. -message ListRuntimesRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "notebooks.googleapis.com/Runtime" - } - ]; - - // Maximum return size of the list call. - int32 page_size = 2; - - // A previous returned page token that can be used to continue listing - // from the last result. - string page_token = 3; -} - -// Response for listing Managed Notebook Runtimes. -message ListRuntimesResponse { - // A list of returned Runtimes. - repeated Runtime runtimes = 1; - - // Page token that can be used to continue listing from the last result in the - // next list call. - string next_page_token = 2; - - // Locations that could not be reached. For example, - // ['us-west1', 'us-central1']. - // A ListRuntimesResponse will only contain either runtimes or unreachables, - repeated string unreachable = 3; -} - -// Request for getting a Managed Notebook Runtime. -message GetRuntimeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Runtime" - } - ]; -} - -// Request for creating a Managed Notebook Runtime. -message CreateRuntimeRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Runtime" - } - ]; - - // Required. User-defined unique ID of this Runtime. - string runtime_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The Runtime to be created. - Runtime runtime = 3 [(google.api.field_behavior) = REQUIRED]; - - // Idempotent request UUID. - string request_id = 4; -} - -// Request for deleting a Managed Notebook Runtime. -message DeleteRuntimeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Runtime" - } - ]; - - // Idempotent request UUID. - string request_id = 2; -} - -// Request for starting a Managed Notebook Runtime. -message StartRuntimeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Idempotent request UUID. - string request_id = 2; -} - -// Request for stopping a Managed Notebook Runtime. -message StopRuntimeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Idempotent request UUID. - string request_id = 2; -} - -// Request for switching a Managed Notebook Runtime. -message SwitchRuntimeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // machine type. - string machine_type = 2; - - // accelerator config. - RuntimeAcceleratorConfig accelerator_config = 3; - - // Idempotent request UUID. - string request_id = 4; -} - -// Request for resetting a Managed Notebook Runtime. -message ResetRuntimeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Idempotent request UUID. - string request_id = 2; -} - -// Request for reporting a Managed Notebook Event. -message ReportRuntimeEventRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Runtime" - } - ]; - - // Required. The VM hardware token for authenticating the VM. - // https://cloud.google.com/compute/docs/instances/verifying-instance-identity - string vm_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The Event to be reported. - Event event = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for getting a new access token. -message RefreshRuntimeTokenInternalRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Runtime" - } - ]; - - // Required. The VM hardware token for authenticating the VM. - // https://cloud.google.com/compute/docs/instances/verifying-instance-identity - string vm_id = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Response with a new access token. -message RefreshRuntimeTokenInternalResponse { - // The OAuth 2.0 access token. - string access_token = 1; - - // Output only. Token expiration time. - google.protobuf.Timestamp expire_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/notebooks_grpc_service_config.json b/third_party/googleapis/google/cloud/notebooks/v1/notebooks_grpc_service_config.json deleted file mode 100644 index 054bae5..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/notebooks_grpc_service_config.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "methodConfig": [ - { - "name": [ - { "service": "google.cloud.notebooks.v1.NotebookService" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService" } - ], - "timeout": "60s", - "retryPolicy": { - "maxAttempts": 5, - "initialBackoff": "0.100s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": ["UNAVAILABLE"] - } - }, - { - "name": [ - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "ListInstances" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "GetInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "CreateInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "RegisterInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "SetInstanceAccelerator" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "SetInstanceMachineType" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "SetInstanceLabels" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "UpdateInstanceConfig" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "DeleteInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "StartInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "StopInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "ResetInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "RollbackInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "ReportInstanceInfo" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "IsInstanceUpgradeable" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "GetInstanceHealth" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "UpgradeInstance" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "UpgradeInstanceInternal" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "UpdateShieldedInstanceConfig" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "ListEnvironments" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "GetEnvironment" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "CreateEnvironment" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "DeleteEnvironment" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "ListSchedules" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "GetSchedule" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "CreateSchedule" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "DeleteSchedule" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "ListExecutions" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "GetExecution" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "CreateExecution" }, - { "service": "google.cloud.notebooks.v1.NotebookService", "method": "DeleteExecution" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "ListRuntimes" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "GetRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "CreateRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "DeleteRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "StartRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "StopRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "SwitchRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "RollbackRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "ReportRuntimeEvent" } - ], - "timeout": "60s" - }, - { - "name": [ - { - "service": "google.longrunning.Operations", - "method": "ListOperations" - } - ], - "timeout": "300s", - "retryPolicy": { - "initialBackoff": "0.100s", - "maxBackoff": "300s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": [ - "UNAVAILABLE", - "DEADLINE_EXCEEDED" - ] - } - } - ] -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/notebooks_v1.yaml b/third_party/googleapis/google/cloud/notebooks/v1/notebooks_v1.yaml deleted file mode 100644 index 7353887..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/notebooks_v1.yaml +++ /dev/null @@ -1,119 +0,0 @@ -type: google.api.Service -config_version: 3 -name: notebooks.googleapis.com -title: Notebooks API - -apis: -- name: google.cloud.notebooks.v1.ManagedNotebookService -- name: google.cloud.notebooks.v1.NotebookService - -types: -- name: google.cloud.notebooks.v1.OperationMetadata - -documentation: - summary: Notebooks API is used to manage notebook resources in Google Cloud. - rules: - - selector: google.cloud.location.Locations.GetLocation - description: Gets information about a location. - - - selector: google.cloud.location.Locations.ListLocations - description: Lists information about the supported locations for this service. - - - selector: google.iam.v1.IAMPolicy.GetIamPolicy - description: |- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - - - selector: google.iam.v1.IAMPolicy.SetIamPolicy - description: |- - Sets the access control policy on the specified resource. Replaces - any existing policy. - - Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` - errors. - - - selector: google.iam.v1.IAMPolicy.TestIamPermissions - description: |- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of - permissions, not a `NOT_FOUND` error. - - Note: This operation is designed to be used for building - permission-aware UIs and command-line tools, not for authorization - checking. This operation may "fail open" without warning. - -backend: - rules: - - selector: google.cloud.location.Locations.GetLocation - deadline: 60.0 - - selector: google.cloud.location.Locations.ListLocations - deadline: 60.0 - - selector: 'google.cloud.notebooks.v1.ManagedNotebookService.*' - deadline: 60.0 - - selector: 'google.cloud.notebooks.v1.NotebookService.*' - deadline: 60.0 - - selector: 'google.iam.v1.IAMPolicy.*' - deadline: 60.0 - - selector: 'google.longrunning.Operations.*' - deadline: 60.0 - - selector: google.longrunning.Operations.GetOperation - deadline: 5.0 - -http: - rules: - - selector: google.cloud.location.Locations.GetLocation - get: '/v1/{name=projects/*/locations/*}' - - selector: google.cloud.location.Locations.ListLocations - get: '/v1/{name=projects/*}/locations' - - selector: google.iam.v1.IAMPolicy.GetIamPolicy - get: '/v1/{resource=projects/*/locations/*/instances/*}:getIamPolicy' - additional_bindings: - - get: '/v1/{resource=projects/*/locations/*/runtimes/*}:getIamPolicy' - - selector: google.iam.v1.IAMPolicy.SetIamPolicy - post: '/v1/{resource=projects/*/locations/*/instances/*}:setIamPolicy' - body: '*' - additional_bindings: - - post: '/v1/{resource=projects/*/locations/*/runtimes/*}:setIamPolicy' - body: '*' - - selector: google.iam.v1.IAMPolicy.TestIamPermissions - post: '/v1/{resource=projects/*/locations/*/instances/*}:testIamPermissions' - body: '*' - additional_bindings: - - post: '/v1/{resource=projects/*/locations/*/runtimes/*}:testIamPermissions' - body: '*' - - selector: google.longrunning.Operations.CancelOperation - post: '/v1/{name=projects/*/locations/*/operations/*}:cancel' - body: '*' - - selector: google.longrunning.Operations.DeleteOperation - delete: '/v1/{name=projects/*/locations/*/operations/*}' - - selector: google.longrunning.Operations.GetOperation - get: '/v1/{name=projects/*/locations/*/operations/*}' - - selector: google.longrunning.Operations.ListOperations - get: '/v1/{name=projects/*/locations/*}/operations' - -authentication: - rules: - - selector: google.cloud.location.Locations.GetLocation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: google.cloud.location.Locations.ListLocations - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: 'google.cloud.notebooks.v1.ManagedNotebookService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: 'google.cloud.notebooks.v1.NotebookService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: 'google.iam.v1.IAMPolicy.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: 'google.longrunning.Operations.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform diff --git a/third_party/googleapis/google/cloud/notebooks/v1/runtime.proto b/third_party/googleapis/google/cloud/notebooks/v1/runtime.proto deleted file mode 100644 index fa4d376..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/runtime.proto +++ /dev/null @@ -1,588 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/notebooks/v1/environment.proto"; -import "google/protobuf/timestamp.proto"; - -option csharp_namespace = "Google.Cloud.Notebooks.V1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "RuntimeProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1"; -option ruby_package = "Google::Cloud::Notebooks::V1"; - -// The definition of a Runtime for a managed notebook instance. -message Runtime { - option (google.api.resource) = { - type: "notebooks.googleapis.com/Runtime" - pattern: "projects/{project}/locations/{location}/runtimes/{runtime}" - }; - - // The definition of the states of this runtime. - enum State { - // State is not specified. - STATE_UNSPECIFIED = 0; - - // The compute layer is starting the runtime. It is not ready for use. - STARTING = 1; - - // The compute layer is installing required frameworks and registering the - // runtime with notebook proxy. It cannot be used. - PROVISIONING = 2; - - // The runtime is currently running. It is ready for use. - ACTIVE = 3; - - // The control logic is stopping the runtime. It cannot be used. - STOPPING = 4; - - // The runtime is stopped. It cannot be used. - STOPPED = 5; - - // The runtime is being deleted. It cannot be used. - DELETING = 6; - - // The runtime is upgrading. It cannot be used. - UPGRADING = 7; - - // The runtime is being created and set up. It is not ready for use. - INITIALIZING = 8; - } - - // The runtime substate. - enum HealthState { - // The runtime substate is unknown. - HEALTH_STATE_UNSPECIFIED = 0; - - // The runtime is known to be in an healthy state - // (for example, critical daemons are running) - // Applies to ACTIVE state. - HEALTHY = 1; - - // The runtime is known to be in an unhealthy state - // (for example, critical daemons are not running) - // Applies to ACTIVE state. - UNHEALTHY = 2; - - // The runtime has not installed health monitoring agent. - // Applies to ACTIVE state. - AGENT_NOT_INSTALLED = 3; - - // The runtime health monitoring agent is not running. - // Applies to ACTIVE state. - AGENT_NOT_RUNNING = 4; - } - - // Output only. The resource name of the runtime. - // Format: - // `projects/{project}/locations/{location}/runtimes/{runtimeId}` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Type of the runtime; currently only supports Compute Engine VM. - oneof runtime_type { - // Use a Compute Engine VM image to start the managed notebook instance. - VirtualMachine virtual_machine = 2; - } - - // Output only. Runtime state. - State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Runtime health_state. - HealthState health_state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The config settings for accessing runtime. - RuntimeAccessConfig access_config = 5; - - // The config settings for software inside the runtime. - RuntimeSoftwareConfig software_config = 6; - - // Output only. Contains Runtime daemon metrics such as Service status and JupyterLab - // stats. - RuntimeMetrics metrics = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Runtime creation time. - google.protobuf.Timestamp create_time = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Runtime update time. - google.protobuf.Timestamp update_time = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// 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` -message RuntimeAcceleratorConfig { - // Type of this accelerator. - enum AcceleratorType { - // Accelerator type is not specified. - ACCELERATOR_TYPE_UNSPECIFIED = 0; - - // Accelerator type is Nvidia Tesla K80. - NVIDIA_TESLA_K80 = 1; - - // Accelerator type is Nvidia Tesla P100. - NVIDIA_TESLA_P100 = 2; - - // Accelerator type is Nvidia Tesla V100. - NVIDIA_TESLA_V100 = 3; - - // Accelerator type is Nvidia Tesla P4. - NVIDIA_TESLA_P4 = 4; - - // Accelerator type is Nvidia Tesla T4. - NVIDIA_TESLA_T4 = 5; - - // Accelerator type is Nvidia Tesla A100. - NVIDIA_TESLA_A100 = 6; - - // (Coming soon) Accelerator type is TPU V2. - TPU_V2 = 7; - - // (Coming soon) Accelerator type is TPU V3. - TPU_V3 = 8; - - // Accelerator type is NVIDIA Tesla T4 Virtual Workstations. - NVIDIA_TESLA_T4_VWS = 9; - - // Accelerator type is NVIDIA Tesla P100 Virtual Workstations. - NVIDIA_TESLA_P100_VWS = 10; - - // Accelerator type is NVIDIA Tesla P4 Virtual Workstations. - NVIDIA_TESLA_P4_VWS = 11; - } - - // Accelerator model. - AcceleratorType type = 1; - - // Count of cores of this accelerator. - int64 core_count = 2; -} - -// Represents a custom encryption key configuration that can be applied to -// a resource. This will encrypt all disks in Virtual Machine. -message 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}` - string kms_key = 1; -} - -// A Local attached disk resource. -message LocalDisk { - // 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. - message RuntimeGuestOsFeature { - // 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 - string type = 1; - } - - // 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). - bool auto_delete = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - bool boot = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - string device_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - repeated RuntimeGuestOsFeature guest_os_features = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - int32 index = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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. - LocalDiskInitializeParams initialize_params = 6 [(google.api.field_behavior) = INPUT_ONLY]; - - // 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 - string interface = 7; - - // Output only. Type of the resource. Always compute#attachedDisk for attached disks. - string kind = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Any valid publicly visible licenses. - repeated string licenses = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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 - string mode = 10; - - // Specifies a valid partial or full URL to an existing Persistent Disk - // resource. - string source = 11; - - // Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - // specified, the default is PERSISTENT. - // Valid values: - // - // * PERSISTENT - // * SCRATCH - string type = 12; -} - -// 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. -message LocalDiskInitializeParams { - // Possible disk types. - enum DiskType { - // Disk type not set. - DISK_TYPE_UNSPECIFIED = 0; - - // Standard persistent disk type. - PD_STANDARD = 1; - - // SSD persistent disk type. - PD_SSD = 2; - - // Balanced persistent disk type. - PD_BALANCED = 3; - - // Extreme persistent disk type. - PD_EXTREME = 4; - } - - // Optional. Provide this property when creating the disk. - string description = 1 [(google.api.field_behavior) = OPTIONAL]; - - // 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. - string disk_name = 2 [(google.api.field_behavior) = OPTIONAL]; - - // 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. - int64 disk_size_gb = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Input only. The type of the boot disk attached to this instance, defaults to - // standard persistent disk (`PD_STANDARD`). - DiskType disk_type = 4 [(google.api.field_behavior) = INPUT_ONLY]; - - // 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. - map<string, string> labels = 5 [(google.api.field_behavior) = OPTIONAL]; -} - -// Specifies the login configuration for Runtime -message RuntimeAccessConfig { - // Possible ways to access runtime. Authentication mode. - // Currently supports: Single User only. - enum RuntimeAccessType { - // Unspecified access. - RUNTIME_ACCESS_TYPE_UNSPECIFIED = 0; - - // Single user login. - SINGLE_USER = 1; - - // Service Account mode. - // In Service Account mode, Runtime creator will specify a SA that exists - // in the consumer project. Using Runtime Service Account field. - // Users accessing the Runtime need ActAs (Service Account User) permission. - SERVICE_ACCOUNT = 2; - } - - // The type of access mode this instance. - RuntimeAccessType access_type = 1; - - // The owner of this runtime after creation. Format: `alias@example.com` - // Currently supports one owner only. - string runtime_owner = 2; - - // Output only. The proxy endpoint that is used to access the runtime. - string proxy_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// 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` -// * `enable_health_monitoring: true` -message RuntimeSoftwareConfig { - // Cron expression in UTC timezone, used to schedule instance auto upgrade. - // Please follow the [cron format](https://en.wikipedia.org/wiki/Cron). - string notebook_upgrade_schedule = 1; - - // Verifies core internal services are running. - // Default: True - optional bool enable_health_monitoring = 2; - - // Runtime will automatically shutdown after idle_shutdown_time. - // Default: True - optional bool idle_shutdown = 3; - - // Time in minutes to wait before shutting down runtime. Default: 180 minutes - int32 idle_shutdown_timeout = 4; - - // Install Nvidia Driver automatically. - // Default: True - bool install_gpu_driver = 5; - - // Specify a custom Cloud Storage path where the GPU driver is stored. - // If not specified, we'll automatically choose from official GPU drivers. - string custom_gpu_driver_path = 6; - - // 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`). - string post_startup_script = 7; - - // Optional. Use a list of container images to use as Kernels in the notebook instance. - repeated ContainerImage kernels = 8 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. Bool indicating whether an newer image is available in an image family. - optional bool upgradeable = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Contains runtime daemon metrics, such as OS and kernels and sessions stats. -message RuntimeMetrics { - // Output only. The system metrics. - map<string, string> system_metrics = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// 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. -message RuntimeShieldedInstanceConfig { - // 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. - bool enable_secure_boot = 1; - - // Defines whether the instance has the vTPM enabled. Enabled by default. - bool enable_vtpm = 2; - - // 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. - bool enable_integrity_monitoring = 3; -} - -// Runtime using Virtual Machine for computing. -message VirtualMachine { - // Output only. The user-friendly name of the Managed Compute Engine instance. - string instance_name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The unique identifier of the Managed Compute Engine instance. - string instance_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Virtual Machine configuration settings. - VirtualMachineConfig virtual_machine_config = 3; -} - -// The config settings for virtual machine. -message VirtualMachineConfig { - // The type of vNIC driver. - // Default should be UNSPECIFIED_NIC_TYPE. - enum NicType { - // No type specified. - UNSPECIFIED_NIC_TYPE = 0; - - // VIRTIO - VIRTIO_NET = 1; - - // GVNIC - GVNIC = 2; - } - - // Definition of the boot image used by the Runtime. - // Used to facilitate runtime upgradeability. - message BootImage { - - } - - // 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` - string zone = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. The Compute Engine machine type used for runtimes. - // Short name is valid. Examples: - // * `n1-standard-2` - // * `e2-standard-8` - string machine_type = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Use a list of container images to use as Kernels in the notebook instance. - repeated ContainerImage container_images = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Required. Data disk option configuration settings. - LocalDisk data_disk = 4 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Encryption settings for virtual machine data disk. - EncryptionConfig encryption_config = 5 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Shielded VM Instance configuration settings. - RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The Compute Engine accelerator configuration for this runtime. - RuntimeAcceleratorConfig accelerator_config = 7 [(google.api.field_behavior) = OPTIONAL]; - - // 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. - string network = 8 [(google.api.field_behavior) = OPTIONAL]; - - // 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` - string subnet = 9 [(google.api.field_behavior) = OPTIONAL]; - - // 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. - bool internal_ip_only = 10 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The Compute Engine tags to add to runtime (see [Tagging - // instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). - repeated string tags = 13 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The Compute Engine guest attributes. (see - // [Project and instance - // guest - // attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)). - map<string, string> guest_attributes = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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)). - map<string, string> metadata = 15 [(google.api.field_behavior) = OPTIONAL]; - - // 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. - map<string, string> labels = 16 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The type of vNIC to be used on this interface. This may be gVNIC or - // VirtioNet. - NicType nic_type = 17 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Reserved IP Range name is used for VPC Peering. - // The subnetwork allocation will use the range *name* if it's assigned. - // - // Example: managed-notebooks-range-c - // PEERING_RANGE_NAME_3=managed-notebooks-range-c - // gcloud compute addresses create $PEERING_RANGE_NAME_3 \ - // --global \ - // --prefix-length=24 \ - // --description="Google Cloud Managed Notebooks Range 24 c" \ - // --network=$NETWORK \ - // --addresses=192.168.0.0 \ - // --purpose=VPC_PEERING - // - // Field value will be: `managed-notebooks-range-c` - string reserved_ip_range = 18 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Boot image metadata used for runtime upgradeability. - BootImage boot_image = 19 [(google.api.field_behavior) = OPTIONAL]; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/schedule.proto b/third_party/googleapis/google/cloud/notebooks/v1/schedule.proto deleted file mode 100644 index eeebae5..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/schedule.proto +++ /dev/null @@ -1,107 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/notebooks/v1/execution.proto"; -import "google/protobuf/timestamp.proto"; - -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "ScheduleProto"; -option java_package = "com.google.cloud.notebooks.v1"; - -// The definition of a schedule. -message Schedule { - option (google.api.resource) = { - type: "notebooks.googleapis.com/Schedule" - pattern: "projects/{project}/location/{location}/schedules/{schedule}" - }; - - // State of the job. - enum State { - // Unspecified state. - STATE_UNSPECIFIED = 0; - - // The job is executing normally. - ENABLED = 1; - - // The job is paused by the user. It will not execute. A user can - // intentionally pause the job using - // [PauseJobRequest][]. - PAUSED = 2; - - // The job is disabled by the system due to error. The user - // cannot directly set a job to be disabled. - DISABLED = 3; - - // The job state resulting from a failed [CloudScheduler.UpdateJob][] - // operation. To recover a job from this state, retry - // [CloudScheduler.UpdateJob][] until a successful response is received. - UPDATE_FAILED = 4; - - // The schedule resource is being created. - INITIALIZING = 5; - - // The schedule resource is being deleted. - DELETING = 6; - } - - // Output only. The name of this schedule. Format: - // `projects/{project_id}/locations/{location}/schedules/{schedule_id}` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Display name used for UI purposes. - // Name can only contain alphanumeric characters, hyphens '-', - // and underscores '_'. - string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // A brief description of this environment. - string description = 3; - - State state = 4; - - // Cron-tab formatted schedule by which the job will execute. - // Format: minute, hour, day of month, month, day of week, - // e.g. 0 0 * * WED = every Wednesday - // More examples: https://crontab.guru/examples.html - string cron_schedule = 5; - - // Timezone on which the cron_schedule. - // The value of this field must be a time zone name from the tz database. - // TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - // - // Note that some time zones include a provision for daylight savings time. - // The rules for daylight saving time are determined by the chosen tz. - // For UTC use the string "utc". If a time zone is not specified, - // the default will be in UTC (also known as GMT). - string time_zone = 6; - - // Output only. Time the schedule was created. - google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time the schedule was last updated. - google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Notebook Execution Template corresponding to this schedule. - ExecutionTemplate execution_template = 9; - - // Output only. The most recent execution names triggered from this schedule and their - // corresponding states. - repeated Execution recent_executions = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; -} diff --git a/third_party/googleapis/google/cloud/notebooks/v1/service.proto b/third_party/googleapis/google/cloud/notebooks/v1/service.proto deleted file mode 100644 index 61ac76c..0000000 --- a/third_party/googleapis/google/cloud/notebooks/v1/service.proto +++ /dev/null @@ -1,988 +0,0 @@ -// Copyright 2022 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. - -syntax = "proto3"; - -package google.cloud.notebooks.v1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/notebooks/v1/environment.proto"; -import "google/cloud/notebooks/v1/execution.proto"; -import "google/cloud/notebooks/v1/instance.proto"; -import "google/cloud/notebooks/v1/instance_config.proto"; -import "google/cloud/notebooks/v1/schedule.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/timestamp.proto"; - -option csharp_namespace = "Google.Cloud.Notebooks.V1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; -option java_multiple_files = true; -option java_outer_classname = "NotebooksProto"; -option java_package = "com.google.cloud.notebooks.v1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1"; -option ruby_package = "Google::Cloud::Notebooks::V1"; - -// API v1 service for Cloud AI Platform Notebooks. -service NotebookService { - option (google.api.default_host) = "notebooks.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; - - // Lists instances in a given project and location. - rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) { - option (google.api.http) = { - get: "/v1/{parent=projects/*/locations/*}/instances" - }; - option (google.api.method_signature) = "parent"; - } - - // Gets details of a single Instance. - rpc GetInstance(GetInstanceRequest) returns (Instance) { - option (google.api.http) = { - get: "/v1/{name=projects/*/locations/*/instances/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Creates a new Instance in a given project and location. - rpc CreateInstance(CreateInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{parent=projects/*/locations/*}/instances" - body: "instance" - }; - option (google.api.method_signature) = "parent,instance,instance_id"; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Registers an existing legacy notebook instance to the Notebooks API server. - // Legacy instances are instances created with the legacy Compute Engine - // calls. They are not manageable by the Notebooks API out of the box. This - // call makes these instances manageable by the Notebooks API. - rpc RegisterInstance(RegisterInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{parent=projects/*/locations/*}/instances:register" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Updates the guest accelerators of a single Instance. - rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - patch: "/v1/{name=projects/*/locations/*/instances/*}:setAccelerator" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Updates the machine type of a single Instance. - rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - patch: "/v1/{name=projects/*/locations/*/instances/*}:setMachineType" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Update Notebook Instance configurations. - rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - patch: "/v1/{name=projects/*/locations/*/instances/*}:updateConfig" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Updates the Shielded instance configuration of a single Instance. - rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - patch: "/v1/{name=projects/*/locations/*/instances/*}:updateShieldedInstanceConfig" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Replaces all the labels of an Instance. - rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - patch: "/v1/{name=projects/*/locations/*/instances/*}:setLabels" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Add/update metadata items for an instance. - rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse) { - option (google.api.http) = { - patch: "/v1/{name=projects/*/locations/*/instances/*}:updateMetadataItems" - body: "*" - }; - } - - // Deletes a single Instance. - rpc DeleteInstance(DeleteInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - delete: "/v1/{name=projects/*/locations/*/instances/*}" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" - }; - } - - // Starts a notebook instance. - rpc StartInstance(StartInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:start" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Stops a notebook instance. - rpc StopInstance(StopInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:stop" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Resets a notebook instance. - rpc ResetInstance(ResetInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:reset" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Allows notebook instances to - // report their latest instance information to the Notebooks - // API server. The server will merge the reported information to - // the instance metadata store. Do not use this method directly. - rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:report" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Check if a notebook instance is upgradable. - rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse) { - option (google.api.http) = { - get: "/v1/{notebook_instance=projects/*/locations/*/instances/*}:isUpgradeable" - }; - } - - // Check if a notebook instance is healthy. - rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse) { - option (google.api.http) = { - get: "/v1/{name=projects/*/locations/*/instances/*}:getInstanceHealth" - }; - option (google.api.method_signature) = "name"; - } - - // Upgrades a notebook instance to the latest version. - rpc UpgradeInstance(UpgradeInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:upgrade" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Rollbacks a notebook instance to the previous version. - rpc RollbackInstance(RollbackInstanceRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:rollback" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Allows notebook instances to - // call this endpoint to upgrade themselves. Do not use this method directly. - rpc UpgradeInstanceInternal(UpgradeInstanceInternalRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/instances/*}:upgradeInternal" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Instance" - metadata_type: "OperationMetadata" - }; - } - - // Lists environments in a project. - rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) { - option (google.api.http) = { - get: "/v1/{parent=projects/*/locations/*}/environments" - }; - option (google.api.method_signature) = "parent"; - } - - // Gets details of a single Environment. - rpc GetEnvironment(GetEnvironmentRequest) returns (Environment) { - option (google.api.http) = { - get: "/v1/{name=projects/*/locations/*/environments/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Creates a new Environment. - rpc CreateEnvironment(CreateEnvironmentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{parent=projects/*/locations/*}/environments" - body: "environment" - }; - option (google.api.method_signature) = "parent,environment,environment_id"; - option (google.longrunning.operation_info) = { - response_type: "Environment" - metadata_type: "OperationMetadata" - }; - } - - // Deletes a single Environment. - rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - delete: "/v1/{name=projects/*/locations/*/environments/*}" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" - }; - } - - // Lists schedules in a given project and location. - rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse) { - option (google.api.http) = { - get: "/v1/{parent=projects/*/locations/*}/schedules" - }; - option (google.api.method_signature) = "parent"; - } - - // Gets details of schedule - rpc GetSchedule(GetScheduleRequest) returns (Schedule) { - option (google.api.http) = { - get: "/v1/{name=projects/*/locations/*/schedules/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Deletes schedule and all underlying jobs - rpc DeleteSchedule(DeleteScheduleRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - delete: "/v1/{name=projects/*/locations/*/schedules/*}" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" - }; - } - - // Creates a new Scheduled Notebook in a given project and location. - rpc CreateSchedule(CreateScheduleRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{parent=projects/*/locations/*}/schedules" - body: "schedule" - }; - option (google.api.method_signature) = "parent,schedule,schedule_id"; - option (google.longrunning.operation_info) = { - response_type: "Schedule" - metadata_type: "OperationMetadata" - }; - } - - // Triggers execution of an existing schedule. - rpc TriggerSchedule(TriggerScheduleRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{name=projects/*/locations/*/schedules/*}:trigger" - body: "*" - }; - option (google.longrunning.operation_info) = { - response_type: "Schedule" - metadata_type: "OperationMetadata" - }; - } - - // Lists executions in a given project and location - rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse) { - option (google.api.http) = { - get: "/v1/{parent=projects/*/locations/*}/executions" - }; - option (google.api.method_signature) = "parent"; - } - - // Gets details of executions - rpc GetExecution(GetExecutionRequest) returns (Execution) { - option (google.api.http) = { - get: "/v1/{name=projects/*/locations/*/executions/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Deletes execution - rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - delete: "/v1/{name=projects/*/locations/*/executions/*}" - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" - }; - } - - // Creates a new Execution in a given project and location. - rpc CreateExecution(CreateExecutionRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v1/{parent=projects/*/locations/*}/executions" - body: "execution" - }; - option (google.api.method_signature) = "parent,execution,execution_id"; - option (google.longrunning.operation_info) = { - response_type: "Execution" - metadata_type: "OperationMetadata" - }; - } -} - -// Represents the metadata of the long-running operation. -message OperationMetadata { - // The time the operation was created. - google.protobuf.Timestamp create_time = 1; - - // The time the operation finished running. - google.protobuf.Timestamp end_time = 2; - - // Server-defined resource path for the target of the operation. - string target = 3; - - // Name of the verb executed by the operation. - string verb = 4; - - // Human-readable status of the operation, if any. - string status_message = 5; - - // Identifies whether the user has requested cancellation - // of the operation. Operations that have successfully been cancelled - // have [Operation.error][] value with a - // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`. - bool requested_cancellation = 6; - - // API version used to start the operation. - string api_version = 7; - - // API endpoint name of this operation. - string endpoint = 8; -} - -// Request for listing notebook instances. -message ListInstancesRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Maximum return size of the list call. - int32 page_size = 2; - - // A previous returned page token that can be used to continue listing - // from the last result. - string page_token = 3; -} - -// Response for listing notebook instances. -message ListInstancesResponse { - // A list of returned instances. - repeated Instance instances = 1; - - // Page token that can be used to continue listing from the last result in the - // next list call. - string next_page_token = 2; - - // Locations that could not be reached. For example, - // ['us-west1-a', 'us-central1-b']. - // A ListInstancesResponse will only contain either instances or unreachables, - repeated string unreachable = 3; -} - -// Request for getting a notebook instance. -message GetInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for creating a notebook instance. -message CreateInstanceRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. User-defined unique ID of this instance. - string instance_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The instance to be created. - Instance instance = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for registering a notebook instance. -message RegisterInstanceRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. User defined unique ID of this instance. The `instance_id` must - // be 1 to 63 characters long and contain only lowercase letters, - // numeric characters, and dashes. The first character must be a lowercase - // letter and the last character cannot be a dash. - string instance_id = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for setting instance accelerator. -message SetInstanceAcceleratorRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. Type of this accelerator. - Instance.AcceleratorType type = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. Count of cores of this accelerator. Note that not all combinations - // of `type` and `core_count` are valid. Check [GPUs on - // Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to - // find a valid combination. TPUs are not supported. - int64 core_count = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for setting instance machine type. -message SetInstanceMachineTypeRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The [Compute Engine machine - // type](https://cloud.google.com/compute/docs/machine-types). - string machine_type = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for updating instance configurations. -message UpdateInstanceConfigRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // The instance configurations to be updated. - InstanceConfig config = 2; -} - -// Request for setting instance labels. -message SetInstanceLabelsRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Labels to apply to this instance. - // These can be later modified by the setLabels method - map<string, string> labels = 2; -} - -// Request for adding/changing metadata items for an instance. -message UpdateInstanceMetadataItemsRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Metadata items to add/update for the instance. - map<string, string> items = 2; -} - -// Response for adding/changing metadata items for an instance. -message UpdateInstanceMetadataItemsResponse { - // Map of items that were added/updated to/in the metadata. - map<string, string> items = 1; -} - -// Request for updating the Shielded Instance config for a notebook instance. -// You can only use this method on a stopped instance -message UpdateShieldedInstanceConfigRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // ShieldedInstance configuration to be updated. - Instance.ShieldedInstanceConfig shielded_instance_config = 2; -} - -// Request for deleting a notebook instance. -message DeleteInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for starting a notebook instance -message StartInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for stopping a notebook instance -message StopInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for resetting a notebook instance -message ResetInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for notebook instances to report information to Notebooks API. -message ReportInstanceInfoRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The VM hardware token for authenticating the VM. - // https://cloud.google.com/compute/docs/instances/verifying-instance-identity - string vm_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // The metadata reported to Notebooks API. This will be merged to the instance - // metadata store - map<string, string> metadata = 3; -} - -// Request for checking if a notebook instance is upgradeable. -message IsInstanceUpgradeableRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string notebook_instance = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The optional UpgradeType. Setting this field will search for additional - // compute images to upgrade this instance. - UpgradeType type = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// Response for checking if a notebook instance is upgradeable. -message IsInstanceUpgradeableResponse { - // If an instance is upgradeable. - bool upgradeable = 1; - - // The version this instance will be upgraded to if calling the upgrade - // endpoint. This field will only be populated if field upgradeable is true. - string upgrade_version = 2; - - // Additional information about upgrade. - string upgrade_info = 3; - - // 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. - string upgrade_image = 4; -} - -// Request for checking if a notebook instance is healthy. -message GetInstanceHealthRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Instance" - } - ]; -} - -// Response for checking if a notebook instance is healthy. -message GetInstanceHealthResponse { - // If an instance is healthy or not. - enum HealthState { - // The instance substate is unknown. - HEALTH_STATE_UNSPECIFIED = 0; - - // The instance is known to be in an healthy state - // (for example, critical daemons are running) - // Applies to ACTIVE state. - HEALTHY = 1; - - // The instance is known to be in an unhealthy state - // (for example, critical daemons are not running) - // Applies to ACTIVE state. - UNHEALTHY = 2; - - // The instance has not installed health monitoring agent. - // Applies to ACTIVE state. - AGENT_NOT_INSTALLED = 3; - - // The instance health monitoring agent is not running. - // Applies to ACTIVE state. - AGENT_NOT_RUNNING = 4; - } - - // Output only. Runtime health_state. - HealthState health_state = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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" - // } - map<string, string> health_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Request for upgrading a notebook instance -message UpgradeInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The optional UpgradeType. Setting this field will search for additional - // compute images to upgrade this instance. - UpgradeType type = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// Request for rollbacking a notebook instance -message RollbackInstanceRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The snapshot for rollback. - // Example: "projects/test-project/global/snapshots/krwlzipynril". - string target_snapshot = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for upgrading a notebook instance from within the VM -message UpgradeInstanceInternalRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/instances/{instance_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The VM hardware token for authenticating the VM. - // https://cloud.google.com/compute/docs/instances/verifying-instance-identity - string vm_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The optional UpgradeType. Setting this field will search for additional - // compute images to upgrade this instance. - UpgradeType type = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// Request for listing environments. -message ListEnvironmentsRequest { - // Required. Format: `projects/{project_id}/locations/{location}` - string parent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Maximum return size of the list call. - int32 page_size = 2; - - // A previous returned page token that can be used to continue listing from - // the last result. - string page_token = 3; -} - -// Response for listing environments. -message ListEnvironmentsResponse { - // A list of returned environments. - repeated Environment environments = 1; - - // A page token that can be used to continue listing from the last result - // in the next list call. - string next_page_token = 2; - - // Locations that could not be reached. - repeated string unreachable = 3; -} - -// Request for getting a notebook environment. -message GetEnvironmentRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/environments/{environment_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for creating a notebook environment. -message CreateEnvironmentRequest { - // Required. Format: `projects/{project_id}/locations/{location}` - string parent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. User-defined unique ID of this environment. The `environment_id` must - // be 1 to 63 characters long and contain only lowercase letters, - // numeric characters, and dashes. The first character must be a lowercase - // letter and the last character cannot be a dash. - string environment_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The environment to be created. - Environment environment = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for deleting a notebook environment. -message DeleteEnvironmentRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/environments/{environment_id}` - string name = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for listing scheduled notebook job. -message ListSchedulesRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Schedule" - } - ]; - - // Maximum return size of the list call. - int32 page_size = 2; - - // A previous returned page token that can be used to continue listing - // from the last result. - string page_token = 3; - - // Filter applied to resulting schedules. - string filter = 4; - - // Field to order results by. - string order_by = 5; -} - -// Response for listing scheduled notebook job. -message ListSchedulesResponse { - // A list of returned instances. - repeated Schedule schedules = 1; - - // Page token that can be used to continue listing from the last result in the - // next list call. - string next_page_token = 2; - - // Schedules that could not be reached. For example: - // - // ['projects/{project_id}/location/{location}/schedules/monthly_digest', - // 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'] - repeated string unreachable = 3; -} - -// Request for getting scheduled notebook. -message GetScheduleRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/schedules/{schedule_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Schedule" - } - ]; -} - -// Request for deleting an Schedule -message DeleteScheduleRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/schedules/{schedule_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Schedule" - } - ]; -} - -// Request for created scheduled notebooks -message CreateScheduleRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Schedule" - } - ]; - - // Required. User-defined unique ID of this schedule. - string schedule_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The schedule to be created. - Schedule schedule = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Request for created scheduled notebooks -message TriggerScheduleRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Schedule" - } - ]; -} - -// Request for listing scheduled notebook executions. -message ListExecutionsRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Execution" - } - ]; - - // Maximum return size of the list call. - int32 page_size = 2; - - // A previous returned page token that can be used to continue listing - // from the last result. - string page_token = 3; - - // Filter applied to resulting executions. Currently only supports filtering - // executions by a specified schedule_id. - // Format: `schedule_id=<Schedule_ID>` - string filter = 4; - - // Sort by field. - string order_by = 5; -} - -// Response for listing scheduled notebook executions -message ListExecutionsResponse { - // A list of returned instances. - repeated Execution executions = 1; - - // Page token that can be used to continue listing from the last result in the - // next list call. - string next_page_token = 2; - - // 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'] - repeated string unreachable = 3; -} - -// Request for getting scheduled notebook execution -message GetExecutionRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/executions/{execution_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Execution" - } - ]; -} - -// Request for deleting a scheduled notebook execution -message DeleteExecutionRequest { - // Required. Format: - // `projects/{project_id}/locations/{location}/executions/{execution_id}` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Execution" - } - ]; -} - -// Request to create notebook execution -message CreateExecutionRequest { - // Required. Format: - // `parent=projects/{project_id}/locations/{location}` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "notebooks.googleapis.com/Execution" - } - ]; - - // Required. User-defined unique ID of this execution. - string execution_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The execution to be created. - Execution execution = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Definition of the types of upgrade that can be used on this -// instance. -enum UpgradeType { - // Upgrade type is not specified. - UPGRADE_TYPE_UNSPECIFIED = 0; - - // Upgrade ML framework. - UPGRADE_FRAMEWORK = 1; - - // Upgrade Operating System. - UPGRADE_OS = 2; - - // Upgrade CUDA. - UPGRADE_CUDA = 3; - - // Upgrade All (OS, Framework and CUDA). - UPGRADE_ALL = 4; -} |