google-cloud-web_security_scanner-v1 0.1.0

data/proto_docs/google/cloud/websecurityscanner/v1/scan_config_error.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        # Defines a custom error message used by CreateScanConfig and UpdateScanConfig
+        # APIs when scan configuration validation fails. It is also reported as part of
+        # a ScanRunErrorTrace message if scan validation fails due to a scan
+        # configuration error.
+        # @!attribute [rw] code
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfigError::Code]
+        #     Output only. Indicates the reason code for a configuration failure.
+        # @!attribute [rw] field_name
+        #   @return [::String]
+        #     Output only. Indicates the full name of the ScanConfig field that triggers this error,
+        #     for example "scan_config.max_qps". This field is provided for
+        #     troubleshooting purposes only and its actual value can change in the
+        #     future.
+        class ScanConfigError
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Output only.
+          # Defines an error reason code.
+          # Next id: 44
+          module Code
+            # There is no error.
+            CODE_UNSPECIFIED = 0
+
+            # There is no error.
+            OK = 0
+
+            # Indicates an internal server error.
+            # Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
+            INTERNAL_ERROR = 1
+
+            # One of the seed URLs is an App Engine URL but we cannot validate the scan
+            # settings due to an App Engine API backend error.
+            APPENGINE_API_BACKEND_ERROR = 2
+
+            # One of the seed URLs is an App Engine URL but we cannot access the
+            # App Engine API to validate scan settings.
+            APPENGINE_API_NOT_ACCESSIBLE = 3
+
+            # One of the seed URLs is an App Engine URL but the Default Host of the
+            # App Engine is not set.
+            APPENGINE_DEFAULT_HOST_MISSING = 4
+
+            # Google corporate accounts can not be used for scanning.
+            CANNOT_USE_GOOGLE_COM_ACCOUNT = 6
+
+            # The account of the scan creator can not be used for scanning.
+            CANNOT_USE_OWNER_ACCOUNT = 7
+
+            # This scan targets Compute Engine, but we cannot validate scan settings
+            # due to a Compute Engine API backend error.
+            COMPUTE_API_BACKEND_ERROR = 8
+
+            # This scan targets Compute Engine, but we cannot access the Compute Engine
+            # API to validate the scan settings.
+            COMPUTE_API_NOT_ACCESSIBLE = 9
+
+            # The Custom Login URL does not belong to the current project.
+            CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT = 10
+
+            # The Custom Login URL is malformed (can not be parsed).
+            CUSTOM_LOGIN_URL_MALFORMED = 11
+
+            # The Custom Login URL is mapped to a non-routable IP address in DNS.
+            CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS = 12
+
+            # The Custom Login URL is mapped to an IP address which is not reserved for
+            # the current project.
+            CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS = 13
+
+            # The Custom Login URL has a non-routable IP address.
+            CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS = 14
+
+            # The Custom Login URL has an IP address which is not reserved for the
+            # current project.
+            CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS = 15
+
+            # Another scan with the same name (case-sensitive) already exists.
+            DUPLICATE_SCAN_NAME = 16
+
+            # A field is set to an invalid value.
+            INVALID_FIELD_VALUE = 18
+
+            # There was an error trying to authenticate to the scan target.
+            FAILED_TO_AUTHENTICATE_TO_TARGET = 19
+
+            # Finding type value is not specified in the list findings request.
+            FINDING_TYPE_UNSPECIFIED = 20
+
+            # Scan targets Compute Engine, yet current project was not whitelisted for
+            # Google Compute Engine Scanning Alpha access.
+            FORBIDDEN_TO_SCAN_COMPUTE = 21
+
+            # User tries to update managed scan
+            FORBIDDEN_UPDATE_TO_MANAGED_SCAN = 43
+
+            # The supplied filter is malformed. For example, it can not be parsed, does
+            # not have a filter type in expression, or the same filter type appears
+            # more than once.
+            MALFORMED_FILTER = 22
+
+            # The supplied resource name is malformed (can not be parsed).
+            MALFORMED_RESOURCE_NAME = 23
+
+            # The current project is not in an active state.
+            PROJECT_INACTIVE = 24
+
+            # A required field is not set.
+            REQUIRED_FIELD = 25
+
+            # Project id, scanconfig id, scanrun id, or finding id are not consistent
+            # with each other in resource name.
+            RESOURCE_NAME_INCONSISTENT = 26
+
+            # The scan being requested to start is already running.
+            SCAN_ALREADY_RUNNING = 27
+
+            # The scan that was requested to be stopped is not running.
+            SCAN_NOT_RUNNING = 28
+
+            # One of the seed URLs does not belong to the current project.
+            SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT = 29
+
+            # One of the seed URLs is malformed (can not be parsed).
+            SEED_URL_MALFORMED = 30
+
+            # One of the seed URLs is mapped to a non-routable IP address in DNS.
+            SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS = 31
+
+            # One of the seed URLs is mapped to an IP address which is not reserved
+            # for the current project.
+            SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS = 32
+
+            # One of the seed URLs has on-routable IP address.
+            SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS = 33
+
+            # One of the seed URLs has an IP address that is not reserved
+            # for the current project.
+            SEED_URL_HAS_UNRESERVED_IP_ADDRESS = 35
+
+            # The Web Security Scanner service account is not configured under the
+            # project.
+            SERVICE_ACCOUNT_NOT_CONFIGURED = 36
+
+            # A project has reached the maximum number of scans.
+            TOO_MANY_SCANS = 37
+
+            # Resolving the details of the current project fails.
+            UNABLE_TO_RESOLVE_PROJECT_INFO = 38
+
+            # One or more blacklist patterns were in the wrong format.
+            UNSUPPORTED_BLACKLIST_PATTERN_FORMAT = 39
+
+            # The supplied filter is not supported.
+            UNSUPPORTED_FILTER = 40
+
+            # The supplied finding type is not supported. For example, we do not
+            # provide findings of the given finding type.
+            UNSUPPORTED_FINDING_TYPE = 41
+
+            # The URL scheme of one or more of the supplied URLs is not supported.
+            UNSUPPORTED_URL_SCHEME = 42
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/websecurityscanner/v1/scan_run.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        # A ScanRun is a output-only resource representing an actual run of the scan.
+        # Next id: 12
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Output only. The resource name of the ScanRun. The name follows the format of
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}'.
+        #     The ScanRun IDs are generated by the system.
+        # @!attribute [rw] execution_state
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun::ExecutionState]
+        #     Output only. The execution state of the ScanRun.
+        # @!attribute [rw] result_state
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun::ResultState]
+        #     Output only. The result state of the ScanRun. This field is only available after the
+        #     execution state reaches "FINISHED".
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the ScanRun started.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the ScanRun reached termination state - that the ScanRun
+        #     is either finished or stopped by user.
+        # @!attribute [rw] urls_crawled_count
+        #   @return [::Integer]
+        #     Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,
+        #     the value represents the number of URLs crawled up to now.
+        # @!attribute [rw] urls_tested_count
+        #   @return [::Integer]
+        #     Output only. The number of URLs tested during this ScanRun. If the scan is in progress,
+        #     the value represents the number of URLs tested up to now. The number of
+        #     URLs tested is usually larger than the number URLS crawled because
+        #     typically a crawled URL is tested with multiple test payloads.
+        # @!attribute [rw] has_vulnerabilities
+        #   @return [::Boolean]
+        #     Output only. Whether the scan run has found any vulnerabilities.
+        # @!attribute [rw] progress_percent
+        #   @return [::Integer]
+        #     Output only. The percentage of total completion ranging from 0 to 100.
+        #     If the scan is in queue, the value is 0.
+        #     If the scan is running, the value ranges from 0 to 100.
+        #     If the scan is finished, the value is 100.
+        # @!attribute [rw] error_trace
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRunErrorTrace]
+        #     Output only. If result_state is an ERROR, this field provides the primary reason for
+        #     scan's termination and more details, if such are available.
+        # @!attribute [rw] warning_traces
+        #   @return [::Array<::Google::Cloud::WebSecurityScanner::V1::ScanRunWarningTrace>]
+        #     Output only. A list of warnings, if such are encountered during this scan run.
+        class ScanRun
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Types of ScanRun execution state.
+          module ExecutionState
+            # Represents an invalid state caused by internal server error. This value
+            # should never be returned.
+            EXECUTION_STATE_UNSPECIFIED = 0
+
+            # The scan is waiting in the queue.
+            QUEUED = 1
+
+            # The scan is in progress.
+            SCANNING = 2
+
+            # The scan is either finished or stopped by user.
+            FINISHED = 3
+          end
+
+          # Types of ScanRun result state.
+          module ResultState
+            # Default value. This value is returned when the ScanRun is not yet
+            # finished.
+            RESULT_STATE_UNSPECIFIED = 0
+
+            # The scan finished without errors.
+            SUCCESS = 1
+
+            # The scan finished with errors.
+            ERROR = 2
+
+            # The scan was terminated by user.
+            KILLED = 3
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/websecurityscanner/v1/scan_run_error_trace.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        # Output only.
+        # Defines an error trace message for a ScanRun.
+        # @!attribute [rw] code
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRunErrorTrace::Code]
+        #     Output only. Indicates the error reason code.
+        # @!attribute [rw] scan_config_error
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfigError]
+        #     Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+        #     message encountered during scan configuration validation that is performed
+        #     before each scan run.
+        # @!attribute [rw] most_common_http_error_code
+        #   @return [::Integer]
+        #     Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+        #     common HTTP error code, if such is available. For example, if this code is
+        #     404, the scan has encountered too many NOT_FOUND responses.
+        class ScanRunErrorTrace
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Output only.
+          # Defines an error reason code.
+          # Next id: 7
+          module Code
+            # Default value is never used.
+            CODE_UNSPECIFIED = 0
+
+            # Indicates that the scan run failed due to an internal server error.
+            INTERNAL_ERROR = 1
+
+            # Indicates a scan configuration error, usually due to outdated ScanConfig
+            # settings, such as starting_urls or the DNS configuration.
+            SCAN_CONFIG_ISSUE = 2
+
+            # Indicates an authentication error, usually due to outdated ScanConfig
+            # authentication settings.
+            AUTHENTICATION_CONFIG_ISSUE = 3
+
+            # Indicates a scan operation timeout, usually caused by a very large site.
+            TIMED_OUT_WHILE_SCANNING = 4
+
+            # Indicates that a scan encountered excessive redirects, either to
+            # authentication or some other page outside of the scan scope.
+            TOO_MANY_REDIRECTS = 5
+
+            # Indicates that a scan encountered numerous errors from the web site
+            # pages. When available, most_common_http_error_code field indicates the
+            # most common HTTP error code encountered during the scan.
+            TOO_MANY_HTTP_ERRORS = 6
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/websecurityscanner/v1/scan_run_warning_trace.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        # Output only.
+        # Defines a warning trace message for ScanRun. Warning traces provide customers
+        # with useful information that helps make the scanning process more effective.
+        # @!attribute [rw] code
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRunWarningTrace::Code]
+        #     Output only. Indicates the warning code.
+        class ScanRunWarningTrace
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Output only.
+          # Defines a warning message code.
+          # Next id: 6
+          module Code
+            # Default value is never used.
+            CODE_UNSPECIFIED = 0
+
+            # Indicates that a scan discovered an unexpectedly low number of URLs. This
+            # is sometimes caused by complex navigation features or by using a single
+            # URL for numerous pages.
+            INSUFFICIENT_CRAWL_RESULTS = 1
+
+            # Indicates that a scan discovered too many URLs to test, or excessive
+            # redundant URLs.
+            TOO_MANY_CRAWL_RESULTS = 2
+
+            # Indicates that too many tests have been generated for the scan. Customer
+            # should try reducing the number of starting URLs, increasing the QPS rate,
+            # or narrowing down the scope of the scan using the excluded patterns.
+            TOO_MANY_FUZZ_TASKS = 3
+
+            # Indicates that a scan is blocked by IAP.
+            BLOCKED_BY_IAP = 4
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/websecurityscanner/v1/web_security_scanner.rb

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        # Request for the `CreateScanConfig` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name where the scan is created, which should be a
+        #     project resource name in the format 'projects/\\{projectId}'.
+        # @!attribute [rw] scan_config
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfig]
+        #     Required. The ScanConfig to be created.
+        class CreateScanConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `DeleteScanConfig` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ScanConfig to be deleted. The name follows the
+        #     format of 'projects/\\{projectId}/scanConfigs/\\{scanConfigId}'.
+        class DeleteScanConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `GetScanConfig` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ScanConfig to be returned. The name follows the
+        #     format of 'projects/\\{projectId}/scanConfigs/\\{scanConfigId}'.
+        class GetScanConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ListScanConfigs` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, which should be a project resource name in the
+        #     format 'projects/\\{projectId}'.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results to be returned. This should be a
+        #     `next_page_token` value returned from a previous List request.
+        #     If unspecified, the first page of results is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of ScanConfigs to return, can be limited by server.
+        #     If not specified or not positive, the implementation will select a
+        #     reasonable value.
+        class ListScanConfigsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `UpdateScanConfigRequest` method.
+        # @!attribute [rw] scan_config
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfig]
+        #     Required. The ScanConfig to be updated. The name field must be set to identify the
+        #     resource to be updated. The values of fields not covered by the mask
+        #     will be ignored.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The update mask applies to the resource. For the `FieldMask` definition,
+        #     see
+        #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+        class UpdateScanConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ListScanConfigs` method.
+        # @!attribute [rw] scan_configs
+        #   @return [::Array<::Google::Cloud::WebSecurityScanner::V1::ScanConfig>]
+        #     The list of ScanConfigs returned.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListScanConfigsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `StartScanRun` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ScanConfig to be used. The name follows the
+        #     format of 'projects/\\{projectId}/scanConfigs/\\{scanConfigId}'.
+        class StartScanRunRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `GetScanRun` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ScanRun to be returned. The name follows the
+        #     format of
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}'.
+        class GetScanRunRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ListScanRuns` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, which should be a scan resource name in the
+        #     format 'projects/\\{projectId}/scanConfigs/\\{scanConfigId}'.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results to be returned. This should be a
+        #     `next_page_token` value returned from a previous List request.
+        #     If unspecified, the first page of results is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of ScanRuns to return, can be limited by server.
+        #     If not specified or not positive, the implementation will select a
+        #     reasonable value.
+        class ListScanRunsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ListScanRuns` method.
+        # @!attribute [rw] scan_runs
+        #   @return [::Array<::Google::Cloud::WebSecurityScanner::V1::ScanRun>]
+        #     The list of ScanRuns returned.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListScanRunsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `StopScanRun` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ScanRun to be stopped. The name follows the
+        #     format of
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}'.
+        class StopScanRunRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ListCrawledUrls` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, which should be a scan run resource name in the
+        #     format
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}'.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results to be returned. This should be a
+        #     `next_page_token` value returned from a previous List request.
+        #     If unspecified, the first page of results is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of CrawledUrls to return, can be limited by server.
+        #     If not specified or not positive, the implementation will select a
+        #     reasonable value.
+        class ListCrawledUrlsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ListCrawledUrls` method.
+        # @!attribute [rw] crawled_urls
+        #   @return [::Array<::Google::Cloud::WebSecurityScanner::V1::CrawledUrl>]
+        #     The list of CrawledUrls returned.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListCrawledUrlsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `GetFinding` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Finding to be returned. The name follows the
+        #     format of
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}/findings/\\{findingId}'.
+        class GetFindingRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ListFindings` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, which should be a scan run resource name in the
+        #     format
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}'.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     The filter expression. The expression must be in the format: <field>
+        #     <operator> <value>.
+        #     Supported field: 'finding_type'.
+        #     Supported operator: '='.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results to be returned. This should be a
+        #     `next_page_token` value returned from a previous List request.
+        #     If unspecified, the first page of results is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of Findings to return, can be limited by server.
+        #     If not specified or not positive, the implementation will select a
+        #     reasonable value.
+        class ListFindingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ListFindings` method.
+        # @!attribute [rw] findings
+        #   @return [::Array<::Google::Cloud::WebSecurityScanner::V1::Finding>]
+        #     The list of Findings returned.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListFindingsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ListFindingTypeStats` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, which should be a scan run resource name in the
+        #     format
+        #     'projects/\\{projectId}/scanConfigs/\\{scanConfigId}/scanRuns/\\{scanRunId}'.
+        class ListFindingTypeStatsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ListFindingTypeStats` method.
+        # @!attribute [rw] finding_type_stats
+        #   @return [::Array<::Google::Cloud::WebSecurityScanner::V1::FindingTypeStats>]
+        #     The list of FindingTypeStats returned.
+        class ListFindingTypeStatsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end