xref: /aosp_15_r20/external/googleapis/google/api/log.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.api;
18
19import "google/api/label.proto";
20
21option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
22option java_multiple_files = true;
23option java_outer_classname = "LogProto";
24option java_package = "com.google.api";
25option objc_class_prefix = "GAPI";
26
27// A description of a log type. Example in YAML format:
28//
29//     - name: library.googleapis.com/activity_history
30//       description: The history of borrowing and returning library items.
31//       display_name: Activity
32//       labels:
33//       - key: /customer_id
34//         description: Identifier of a library customer
35message LogDescriptor {
36  // The name of the log. It must be less than 512 characters long and can
37  // include the following characters: upper- and lower-case alphanumeric
38  // characters [A-Za-z0-9], and punctuation characters including
39  // slash, underscore, hyphen, period [/_-.].
40  string name = 1;
41
42  // The set of labels that are available to describe a specific log entry.
43  // Runtime requests that contain labels not specified here are
44  // considered invalid.
45  repeated LabelDescriptor labels = 2;
46
47  // A human-readable description of this log. This information appears in
48  // the documentation and can contain details.
49  string description = 3;
50
51  // The human-readable name for this log. This information appears on
52  // the user interface and should be concise.
53  string display_name = 4;
54}
55