xref: /aosp_15_r20/external/googleapis/google/cloud/notebooks/v2/event.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.notebooks.v2;
18
19import "google/api/field_behavior.proto";
20import "google/protobuf/timestamp.proto";
21
22option csharp_namespace = "Google.Cloud.Notebooks.V2";
23option go_package = "cloud.google.com/go/notebooks/apiv2/notebookspb;notebookspb";
24option java_multiple_files = true;
25option java_outer_classname = "EventProto";
26option java_package = "com.google.cloud.notebooks.v2";
27option php_namespace = "Google\\Cloud\\Notebooks\\V2";
28option ruby_package = "Google::Cloud::Notebooks::V2";
29
30// The definition of an Event for a managed / semi-managed notebook instance.
31message Event {
32  // The definition of the event types.
33  enum EventType {
34    // Event is not specified.
35    EVENT_TYPE_UNSPECIFIED = 0;
36
37    // The instance / runtime is idle
38    IDLE = 1;
39
40    // The instance / runtime is available.
41    // This event indicates that instance / runtime underlying compute is
42    // operational.
43    HEARTBEAT = 2;
44
45    // The instance / runtime health is available.
46    // This event indicates that instance / runtime health information.
47    HEALTH = 3;
48
49    // The instance / runtime is available.
50    // This event allows instance / runtime to send Host maintenance
51    // information to Control Plane.
52    // https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
53    MAINTENANCE = 4;
54
55    // The instance / runtime is available.
56    // This event indicates that the instance had metadata that needs to be
57    // modified.
58    METADATA_CHANGE = 5;
59  }
60
61  // Optional. Event report time.
62  google.protobuf.Timestamp report_time = 1
63      [(google.api.field_behavior) = OPTIONAL];
64
65  // Optional. Event type.
66  EventType type = 2 [(google.api.field_behavior) = OPTIONAL];
67
68  // Optional. Event details. This field is used to pass event information.
69  map<string, string> details = 3 [(google.api.field_behavior) = OPTIONAL];
70}
71