xref: /aosp_15_r20/external/googleapis/google/cloud/notebooks/v1/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.v1;
18
19import "google/api/field_behavior.proto";
20import "google/protobuf/timestamp.proto";
21
22option go_package = "cloud.google.com/go/notebooks/apiv1/notebookspb;notebookspb";
23option java_multiple_files = true;
24option java_outer_classname = "EventProto";
25option java_package = "com.google.cloud.notebooks.v1";
26
27// The definition of an Event for a managed / semi-managed notebook instance.
28message Event {
29  // The definition of the event types.
30  enum EventType {
31    // Event is not specified.
32    EVENT_TYPE_UNSPECIFIED = 0;
33
34    // The instance / runtime is idle
35    IDLE = 1;
36
37    // The instance / runtime is available.
38    // This event indicates that instance / runtime underlying compute is
39    // operational.
40    HEARTBEAT = 2;
41
42    // The instance / runtime health is available.
43    // This event indicates that instance / runtime health information.
44    HEALTH = 3;
45
46    // The instance / runtime is available.
47    // This event allows instance / runtime to send Host maintenance
48    // information to Control Plane.
49    // https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
50    MAINTENANCE = 4;
51  }
52
53  // Event report time.
54  google.protobuf.Timestamp report_time = 1;
55
56  // Event type.
57  EventType type = 2;
58
59  // Optional. Event details. This field is used to pass event information.
60  map<string, string> details = 3 [(google.api.field_behavior) = OPTIONAL];
61}
62