feat: add google/rpc/context/audit_context.proto (#152)

Source-Link: googleapis/synthtool@7197a00
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:c43f1d918bcf817d337aa29ff833439494a158a0831508fda4ec75dc4c0d0320

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

.github/.OwlBot.lock.yaml

@@ -1,4 +1,4 @@
-# Copyright 2022 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,4 +13,4 @@
 # limitations under the License.
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
-  digest: sha256:3bf87e47c2173d7eed42714589dc4da2c07c3268610f1e47f8e1a30decbfc7f1
+  digest: sha256:c43f1d918bcf817d337aa29ff833439494a158a0831508fda4ec75dc4c0d0320

.kokoro/samples/python3.11/common.cfg

@@ -0,0 +1,40 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+# Build logs will be here
+action {
+  define_artifacts {
+    regex: "**/*sponge_log.xml"
+  }
+}
+
+# Specify which tests to run
+env_vars: {
+    key: "RUN_TESTS_SESSION"
+    value: "py-3.11"
+}
+
+# Declare build specific Cloud project.
+env_vars: {
+    key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    value: "python-docs-samples-tests-311"
+}
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-api-common-protos/.kokoro/test-samples.sh"
+}
+
+# Configure the docker image for kokoro-trampoline.
+env_vars: {
+    key: "TRAMPOLINE_IMAGE"
+    value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
+}
+
+# Download secrets for samples
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
+
+# Download trampoline resources.
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
+
+# Use the trampoline script to run in docker.
+build_file: "python-api-common-protos/.kokoro/trampoline_v2.sh"

.kokoro/samples/python3.11/continuous.cfg

@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}

.kokoro/samples/python3.11/periodic-head.cfg

@@ -0,0 +1,11 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-api-common-protos/.kokoro/test-samples-against-head.sh"
+}

.kokoro/samples/python3.11/periodic.cfg

@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "False"
+}

.kokoro/samples/python3.11/presubmit.cfg

@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}

google/rpc/code.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// 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.
@@ -30,7 +30,7 @@ option objc_class_prefix = "RPC";
 // `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
 // Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
 enum Code {
-  // Not an error; returned on success
+  // Not an error; returned on success.
   //
   // HTTP Mapping: 200 OK
   OK = 0;
@@ -69,7 +69,7 @@ enum Code {
   // Some requested entity (e.g., file or directory) was not found.
   //
   // Note to server developers: if a request is denied for an entire class
-  // of users, such as gradual feature rollout or undocumented whitelist,
+  // of users, such as gradual feature rollout or undocumented allowlist,
   // `NOT_FOUND` may be used. If a request is denied for some users within
   // a class of users, such as user-based access control, `PERMISSION_DENIED`
   // must be used.
@@ -115,11 +115,11 @@ enum Code {
   // Service implementors can use the following guidelines to decide
   // between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
   //  (a) Use `UNAVAILABLE` if the client can retry just the failing call.
-  //  (b) Use `ABORTED` if the client should retry at a higher level
-  //      (e.g., when a client-specified test-and-set fails, indicating the
-  //      client should restart a read-modify-write sequence).
+  //  (b) Use `ABORTED` if the client should retry at a higher level. For
+  //      example, when a client-specified test-and-set fails, indicating the
+  //      client should restart a read-modify-write sequence.
   //  (c) Use `FAILED_PRECONDITION` if the client should not retry until
-  //      the system state has been explicitly fixed.  E.g., if an "rmdir"
+  //      the system state has been explicitly fixed. For example, if an "rmdir"
   //      fails because the directory is non-empty, `FAILED_PRECONDITION`
   //      should be returned since the client should not retry unless
   //      the files are deleted from the directory.

google/rpc/context/attribute_context.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// 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.
@@ -61,7 +61,7 @@ message AttributeContext {
 
     // The identity of this peer. Similar to `Request.auth.principal`, but
     // relative to the peer instead of the request. For example, the
-    // idenity associated with a load balancer that forwared the request.
+    // identity associated with a load balancer that forwarded the request.
     string principal = 7;
 
     // The CLDR country/region code associated with the above IP address.
@@ -170,7 +170,7 @@ message AttributeContext {
     // lowercased, because HTTP header keys are case-insensitive.
     map<string, string> headers = 3;
 
-    // The HTTP URL path.
+    // The HTTP URL path, excluding the query parameters.
     string path = 4;
 
     // The HTTP request `Host` header value.
@@ -223,7 +223,7 @@ message AttributeContext {
     // the response.
     google.protobuf.Timestamp time = 4;
 
-    // The length of time it takes the backend service to fully respond to a
+    // The amount of time it takes the backend service to fully respond to a
     // request. Measured from when the destination service starts to send the
     // request to the backend until when the destination service receives the
     // complete response from the backend.
@@ -256,7 +256,8 @@ message AttributeContext {
     // The type of the resource. The syntax is platform-specific because
     // different platforms define their resources differently.
     //
-    // For Google APIs, the type format must be "{service}/{kind}".
+    // For Google APIs, the type format must be "{service}/{kind}", such as
+    // "pubsub.googleapis.com/Topic".
     string type = 3;
 
     // The labels or tags on the resource, such as AWS resource tags and

google/rpc/context/audit_context.proto

@@ -0,0 +1,49 @@
+// 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.rpc.context;
+
+import "google/protobuf/struct.proto";
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/rpc/context;context";
+option java_multiple_files = true;
+option java_outer_classname = "AuditContextProto";
+option java_package = "com.google.rpc.context";
+
+// `AuditContext` provides information that is needed for audit logging.
+message AuditContext {
+  // Serialized audit log.
+  bytes audit_log = 1;
+
+  // An API request message that is scrubbed based on the method annotation.
+  // This field should only be filled if audit_log field is present.
+  // Service Control will use this to assemble a complete log for Cloud Audit
+  // Logs and Google internal audit logs.
+  google.protobuf.Struct scrubbed_request = 2;
+
+  // An API response message that is scrubbed based on the method annotation.
+  // This field should only be filled if audit_log field is present.
+  // Service Control will use this to assemble a complete log for Cloud Audit
+  // Logs and Google internal audit logs.
+  google.protobuf.Struct scrubbed_response = 3;
+
+  // Number of scrubbed response items.
+  int32 scrubbed_response_item_count = 4;
+
+  // Audit resource name which is scrubbed.
+  string target_resource = 5;
+}

google/rpc/context/audit_context_pb2.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 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.
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/rpc/context/audit_context.proto
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
+    b'\n&google/rpc/context/audit_context.proto\x12\x12google.rpc.context\x1a\x1cgoogle/protobuf/struct.proto"\xc7\x01\n\x0c\x41uditContext\x12\x11\n\taudit_log\x18\x01 \x01(\x0c\x12\x31\n\x10scrubbed_request\x18\x02 \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x32\n\x11scrubbed_response\x18\x03 \x01(\x0b\x32\x17.google.protobuf.Struct\x12$\n\x1cscrubbed_response_item_count\x18\x04 \x01(\x05\x12\x17\n\x0ftarget_resource\x18\x05 \x01(\tBk\n\x16\x63om.google.rpc.contextB\x11\x41uditContextProtoP\x01Z9google.golang.org/genproto/googleapis/rpc/context;context\xf8\x01\x01\x62\x06proto3'
+)
+
+
+_AUDITCONTEXT = DESCRIPTOR.message_types_by_name["AuditContext"]
+AuditContext = _reflection.GeneratedProtocolMessageType(
+    "AuditContext",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _AUDITCONTEXT,
+        "__module__": "google.rpc.context.audit_context_pb2"
+        # @@protoc_insertion_point(class_scope:google.rpc.context.AuditContext)
+    },
+)
+_sym_db.RegisterMessage(AuditContext)
+
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+    DESCRIPTOR._options = None
+    DESCRIPTOR._serialized_options = b"\n\026com.google.rpc.contextB\021AuditContextProtoP\001Z9google.golang.org/genproto/googleapis/rpc/context;context\370\001\001"
+    _AUDITCONTEXT._serialized_start = 93
+    _AUDITCONTEXT._serialized_end = 292
+# @@protoc_insertion_point(module_scope)