docs: Publish Scan Run logging proto for documentation

PiperOrigin-RevId: 470878694

google/cloud/websecurityscanner/v1/BUILD.bazel

@@ -1,4 +1,13 @@
 # This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+#    * extra_protoc_parameters
+#    * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
 
 # This is an API workspace, having public visibility by default makes perfect sense.
 package(default_visibility = ["//visibility:public"])
@@ -20,6 +29,7 @@ proto_library(
         "scan_config_error.proto",
         "scan_run.proto",
         "scan_run_error_trace.proto",
+        "scan_run_log.proto",
         "scan_run_warning_trace.proto",
         "web_security_scanner.proto",
     ],
@@ -68,13 +78,16 @@ java_grpc_library(
 java_gapic_library(
     name = "websecurityscanner_java_gapic",
     srcs = [":websecurityscanner_proto_with_info"],
+    gapic_yaml = None,
     grpc_service_config = "websecurityscanner_grpc_service_config.json",
+    service_yaml = "websecurityscanner_v1.yaml",
     test_deps = [
         ":websecurityscanner_java_grpc",
     ],
     transport = "grpc+rest",
     deps = [
         ":websecurityscanner_java_proto",
+        "//google/api:api_java_proto",
     ],
 )
 
@@ -126,6 +139,7 @@ go_gapic_library(
     srcs = [":websecurityscanner_proto_with_info"],
     grpc_service_config = "websecurityscanner_grpc_service_config.json",
     importpath = "cloud.google.com/go/websecurityscanner/apiv1;websecurityscanner",
+    metadata = True,
     service_yaml = "websecurityscanner_v1.yaml",
     transport = "grpc+rest",
     deps = [
@@ -145,6 +159,7 @@ go_gapic_assembly_pkg(
     name = "gapi-cloud-websecurityscanner-v1-go",
     deps = [
         ":websecurityscanner_go_gapic",
+        ":websecurityscanner_go_gapic_srcjar-metadata.srcjar",
         ":websecurityscanner_go_gapic_srcjar-test.srcjar",
         ":websecurityscanner_go_proto",
     ],
@@ -164,6 +179,9 @@ py_gapic_library(
     name = "websecurityscanner_py_gapic",
     srcs = [":websecurityscanner_proto"],
     grpc_service_config = "websecurityscanner_grpc_service_config.json",
+    service_yaml = "websecurityscanner_v1.yaml",
+    deps = [
+    ],
 )
 
 py_test(
@@ -210,6 +228,7 @@ php_gapic_library(
     name = "websecurityscanner_php_gapic",
     srcs = [":websecurityscanner_proto_with_info"],
     grpc_service_config = "websecurityscanner_grpc_service_config.json",
+    service_yaml = "websecurityscanner_v1.yaml",
     deps = [
         ":websecurityscanner_php_grpc",
         ":websecurityscanner_php_proto",
@@ -280,15 +299,16 @@ ruby_cloud_gapic_library(
     name = "websecurityscanner_ruby_gapic",
     srcs = [":websecurityscanner_proto_with_info"],
     extra_protoc_parameters = [
-        "ruby-cloud-gem-name=google-cloud-web_security_scanner-v1",
-        "ruby-cloud-env-prefix=WEB_SECURITY_SCANNER",
-        "ruby-cloud-product-url=https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/",
         "ruby-cloud-api-id=websecurityscanner.googleapis.com",
         "ruby-cloud-api-shortname=websecurityscanner",
+        "ruby-cloud-env-prefix=WEB_SECURITY_SCANNER",
+        "ruby-cloud-gem-name=google-cloud-web_security_scanner-v1",
+        "ruby-cloud-product-url=https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/",
     ],
     grpc_service_config = "websecurityscanner_grpc_service_config.json",
     ruby_cloud_description = "Web Security Scanner scans your Compute and App Engine apps for common web vulnerabilities.",
     ruby_cloud_title = "Web Security Scanner V1",
+    service_yaml = "websecurityscanner_v1.yaml",
     deps = [
         ":websecurityscanner_ruby_grpc",
         ":websecurityscanner_ruby_proto",

google/cloud/websecurityscanner/v1/scan_run_log.proto

@@ -0,0 +1,55 @@
+// 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.cloud.websecurityscanner.v1;
+
+import "google/cloud/websecurityscanner/v1/scan_run.proto";
+import "google/cloud/websecurityscanner/v1/scan_run_error_trace.proto";
+
+option csharp_namespace = "Google.Cloud.WebSecurityScanner.V1";
+option go_package = "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1;websecurityscanner";
+option java_multiple_files = true;
+option java_outer_classname = "ScanRunLogProto";
+option java_package = "com.google.cloud.websecurityscanner.v1";
+option php_namespace = "Google\\Cloud\\WebSecurityScanner\\V1";
+option ruby_package = "Google::Cloud::WebSecurityScanner::V1";
+
+// A ScanRunLog is an output-only proto used for Stackdriver customer logging.
+// It is used for logs covering the start and end of scan pipelines.
+// Other than an added summary, this is a subset of the ScanRun.
+// Representation in logs is either a proto Struct, or converted to JSON.
+// Next id: 9
+message ScanRunLog {
+  // Human friendly message about the event.
+  string summary = 1;
+
+  // The resource name of the ScanRun being logged.
+  string name = 2;
+
+  // The execution state of the ScanRun.
+  google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 3;
+
+  // The result state of the ScanRun.
+  google.cloud.websecurityscanner.v1.ScanRun.ResultState result_state = 4;
+
+  int64 urls_crawled_count = 5;
+
+  int64 urls_tested_count = 6;
+
+  bool has_findings = 7;
+
+  google.cloud.websecurityscanner.v1.ScanRunErrorTrace error_trace = 8;
+}