Skip to content

Commit 8a417de

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Publish identitytoolkit request log proto
PiperOrigin-RevId: 461678527
1 parent 8a79ffe commit 8a417de

2 files changed

Lines changed: 270 additions & 0 deletions

File tree

‎google/cloud/identitytoolkit/logging/BUILD.bazel‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# This file was automatically generated by BuildFileGenerator
2+
3+
# This is an API workspace, having public visibility by default makes perfect sense.
4+
package(default_visibility = ["//visibility:public"])
5+
6+
##############################################################################
7+
# Common
8+
##############################################################################
9+
load("@rules_proto//proto:defs.bzl", "proto_library")
10+
11+
proto_library(
12+
name = "logging_proto",
13+
srcs = [
14+
"request_log.proto",
15+
],
16+
deps = [
17+
"//google/rpc:status_proto",
18+
"@com_google_protobuf//:struct_proto",
19+
],
20+
)
21+
22+
##############################################################################
23+
# Java
24+
##############################################################################
25+
load(
26+
"@com_google_googleapis_imports//:imports.bzl",
27+
"java_grpc_library",
28+
"java_proto_library",
29+
)
30+
31+
java_proto_library(
32+
name = "logging_java_proto",
33+
deps = [":logging_proto"],
34+
)
35+
36+
java_grpc_library(
37+
name = "logging_java_grpc",
38+
srcs = [":logging_proto"],
39+
deps = [":logging_java_proto"],
40+
)
41+
42+
##############################################################################
43+
# Go
44+
##############################################################################
45+
load(
46+
"@com_google_googleapis_imports//:imports.bzl",
47+
"go_proto_library",
48+
)
49+
50+
go_proto_library(
51+
name = "logging_go_proto",
52+
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
53+
importpath = "google.golang.org/genproto/googleapis/cloud/identitytoolkit/logging",
54+
protos = [":logging_proto"],
55+
deps = [
56+
"//google/rpc:status_go_proto",
57+
],
58+
)
59+
60+
##############################################################################
61+
# Python
62+
##############################################################################
63+
load(
64+
"@com_google_googleapis_imports//:imports.bzl",
65+
"moved_proto_library",
66+
"py_grpc_library",
67+
"py_proto_library",
68+
)
69+
70+
moved_proto_library(
71+
name = "logging_moved_proto",
72+
srcs = [":logging_proto"],
73+
deps = [
74+
"//google/rpc:status_proto",
75+
"@com_google_protobuf//:struct_proto",
76+
],
77+
)
78+
79+
py_proto_library(
80+
name = "logging_py_proto",
81+
deps = [":logging_moved_proto"],
82+
)
83+
84+
py_grpc_library(
85+
name = "logging_py_grpc",
86+
srcs = [":logging_moved_proto"],
87+
deps = [":logging_py_proto"],
88+
)
89+
90+
##############################################################################
91+
# PHP
92+
##############################################################################
93+
load(
94+
"@com_google_googleapis_imports//:imports.bzl",
95+
"php_grpc_library",
96+
"php_proto_library",
97+
)
98+
99+
php_proto_library(
100+
name = "logging_php_proto",
101+
deps = [":logging_proto"],
102+
)
103+
104+
php_grpc_library(
105+
name = "logging_php_grpc",
106+
srcs = [":logging_proto"],
107+
deps = [":logging_php_proto"],
108+
)
109+
110+
##############################################################################
111+
# Node.js
112+
##############################################################################
113+
load(
114+
"@com_google_googleapis_imports//:imports.bzl",
115+
"nodejs_gapic_assembly_pkg",
116+
"nodejs_gapic_library",
117+
)
118+
119+
120+
##############################################################################
121+
# Ruby
122+
##############################################################################
123+
load(
124+
"@com_google_googleapis_imports//:imports.bzl",
125+
"ruby_grpc_library",
126+
"ruby_proto_library",
127+
)
128+
129+
ruby_proto_library(
130+
name = "logging_ruby_proto",
131+
deps = [":logging_proto"],
132+
)
133+
134+
ruby_grpc_library(
135+
name = "logging_ruby_grpc",
136+
srcs = [":logging_proto"],
137+
deps = [":logging_ruby_proto"],
138+
)
139+
140+
##############################################################################
141+
# C#
142+
##############################################################################
143+
load(
144+
"@com_google_googleapis_imports//:imports.bzl",
145+
"csharp_grpc_library",
146+
"csharp_proto_library",
147+
)
148+
149+
csharp_proto_library(
150+
name = "logging_csharp_proto",
151+
deps = [":logging_proto"],
152+
)
153+
154+
csharp_grpc_library(
155+
name = "logging_csharp_grpc",
156+
srcs = [":logging_proto"],
157+
deps = [":logging_csharp_proto"],
158+
)
159+
160+
##############################################################################
161+
# C++
162+
##############################################################################
163+
load(
164+
"@com_google_googleapis_imports//:imports.bzl",
165+
"cc_grpc_library",
166+
"cc_proto_library",
167+
)
168+
169+
cc_proto_library(
170+
name = "logging_cc_proto",
171+
deps = [":logging_proto"],
172+
)
173+
174+
cc_grpc_library(
175+
name = "logging_cc_grpc",
176+
srcs = [":logging_proto"],
177+
grpc_only = True,
178+
deps = [":logging_cc_proto"],
179+
)

‎google/cloud/identitytoolkit/logging/request_log.proto‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
// Copyright 2022 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+
15+
syntax = "proto3";
16+
17+
package google.cloud.identitytoolkit.logging;
18+
19+
import "google/protobuf/struct.proto";
20+
import "google/rpc/status.proto";
21+
22+
option go_package = "google.golang.org/genproto/googleapis/cloud/identitytoolkit/logging;logging";
23+
option java_multiple_files = true;
24+
option java_outer_classname = "RequestLogProto";
25+
option java_package = "com.google.cloud.identitytoolkit.logging";
26+
27+
// Log of a request to Identitytoolkit. This proto is modeled after
28+
// google.cloud.audit.AuditLog so that consumers can easily query
29+
// for requests regardless of whether those requests were logged via
30+
// Cloud Audit Logging or Identitytoolkit request logging.
31+
message RequestLog {
32+
// The name of the service method or operation.
33+
// For API calls, this should be the name of the API method.
34+
// For example,
35+
//
36+
// "google.datastore.v1.Datastore.RunQuery"
37+
// "google.logging.v1.LoggingService.DeleteLog"
38+
string method_name = 1;
39+
40+
// The status of the overall operation.
41+
google.rpc.Status status = 2;
42+
43+
// Metadata about the operation.
44+
RequestMetadata request_metadata = 3;
45+
46+
// The operation request. This may not include all request parameters,
47+
// such as those that are too large, privacy-sensitive, or duplicated
48+
// elsewhere in the log record.
49+
// It should never include user-generated data, such as file contents.
50+
// When the JSON object represented here has a proto equivalent, the proto
51+
// name will be indicated in the `@type` property.
52+
google.protobuf.Struct request = 4;
53+
54+
// The operation response. This may not include all response elements,
55+
// such as those that are too large, privacy-sensitive, or duplicated
56+
// elsewhere in the log record.
57+
// It should never include user-generated data, such as file contents.
58+
// When the JSON object represented here has a proto equivalent, the proto
59+
// name will be indicated in the `@type` property.
60+
google.protobuf.Struct response = 5;
61+
62+
// The number of items returned from a List or Query API method,
63+
// if applicable.
64+
int64 num_response_items = 6;
65+
66+
// Other service-specific data about the request, response, and other
67+
// information associated with the current event.
68+
google.protobuf.Struct metadata = 7;
69+
}
70+
71+
// Metadata about the request.
72+
message RequestMetadata {
73+
// The IP address of the caller.
74+
string caller_ip = 1;
75+
76+
// The user agent of the caller.
77+
// This information is not authenticated and should be treated
78+
// accordingly.
79+
//
80+
// For example:
81+
//
82+
// + `google-api-python-client/1.4.0`:
83+
// The request was made by the Google API client for Python.
84+
// + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:
85+
// The request was made by the Google Cloud SDK CLI (gcloud).
86+
// + `AppEngine-Google; (+http://code.google.com/appengine; appid:
87+
// s~my-project`:
88+
// The request was made from the `my-project` App Engine app.
89+
// NOLINT
90+
string caller_supplied_user_agent = 2;
91+
}

0 commit comments

Comments
 (0)