1// Copyright 2019 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 16syntax = "proto3"; 17 18package google.cloud.websecurityscanner.v1beta; 19 20import "google/cloud/websecurityscanner/v1beta/scan_config_error.proto"; 21 22option csharp_namespace = "Google.Cloud.WebSecurityScanner.V1Beta"; 23option go_package = "cloud.google.com/go/websecurityscanner/apiv1beta/websecurityscannerpb;websecurityscannerpb"; 24option java_multiple_files = true; 25option java_outer_classname = "ScanRunErrorTraceProto"; 26option java_package = "com.google.cloud.websecurityscanner.v1beta"; 27option php_namespace = "Google\\Cloud\\WebSecurityScanner\\V1beta"; 28option ruby_package = "Google::Cloud::WebSecurityScanner::V1beta"; 29 30// Output only. 31// Defines an error trace message for a ScanRun. 32message ScanRunErrorTrace { 33 // Output only. 34 // Defines an error reason code. 35 // Next id: 7 36 enum Code { 37 // Default value is never used. 38 CODE_UNSPECIFIED = 0; 39 40 // Indicates that the scan run failed due to an internal server error. 41 INTERNAL_ERROR = 1; 42 43 // Indicates a scan configuration error, usually due to outdated ScanConfig 44 // settings, such as starting_urls or the DNS configuration. 45 SCAN_CONFIG_ISSUE = 2; 46 47 // Indicates an authentication error, usually due to outdated ScanConfig 48 // authentication settings. 49 AUTHENTICATION_CONFIG_ISSUE = 3; 50 51 // Indicates a scan operation timeout, usually caused by a very large site. 52 TIMED_OUT_WHILE_SCANNING = 4; 53 54 // Indicates that a scan encountered excessive redirects, either to 55 // authentication or some other page outside of the scan scope. 56 TOO_MANY_REDIRECTS = 5; 57 58 // Indicates that a scan encountered numerous errors from the web site 59 // pages. When available, most_common_http_error_code field indicates the 60 // most common HTTP error code encountered during the scan. 61 TOO_MANY_HTTP_ERRORS = 6; 62 } 63 64 // Indicates the error reason code. 65 Code code = 1; 66 67 // If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error 68 // message encountered during scan configuration validation that is performed 69 // before each scan run. 70 ScanConfigError scan_config_error = 2; 71 72 // If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most 73 // common HTTP error code, if such is available. For example, if this code is 74 // 404, the scan has encountered too many NOT_FOUND responses. 75 int32 most_common_http_error_code = 3; 76} 77