8000 docs: Publish Scan Run logging proto for documentation by gcf-owl-bot[bot] · Pull Request #230 · googleapis/python-websecurityscanner · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions google/cloud/websecurityscanner/__init__.py
8000
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
from google.cloud.websecurityscanner_v1.types.scan_run_error_trace import (
ScanRunErrorTrace,
)
from google.cloud.websecurityscanner_v1.types.scan_run_log import ScanRunLog
from google.cloud.websecurityscanner_v1.types.scan_run_warning_trace import (
ScanRunWarningTrace,
)
Expand Down Expand Up @@ -77,6 +78,7 @@
"ScanConfigError",
"ScanRun",
"ScanRunErrorTrace",
"ScanRunLog",
"ScanRunWarningTrace",
"CreateScanConfigRequest",
"DeleteScanConfigRequest",
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/websecurityscanner_v1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from .types.scan_config_error import ScanConfigError
from .types.scan_run import ScanRun
from .types.scan_run_error_trace import ScanRunErrorTrace
from .types.scan_run_log import ScanRunLog
from .types.scan_run_warning_trace import ScanRunWarningTrace
from .types.web_security_scanner import (
CreateScanConfigRequest,
Expand Down Expand Up @@ -81,6 +82,7 @@
"ScanConfigError",
"ScanRun",
"ScanRunErrorTrace",
"ScanRunLog",
"ScanRunWarningTrace",
"StartScanRunRequest",
"StopScanRunRequest",
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/websecurityscanner_v1/types/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
from .scan_config_error import ScanConfigError
from .scan_run import ScanRun
from .scan_run_error_trace import ScanRunErrorTrace
from .scan_run_log import ScanRunLog
from .scan_run_warning_trace import ScanRunWarningTrace
from .web_security_scanner import (
CreateScanConfigRequest,
Expand Down Expand Up @@ -64,6 +65,7 @@
"ScanConfigError",
"ScanRun",
"ScanRunErrorTrace",
"ScanRunLog",
"ScanRunWarningTrace",
"CreateScanConfigRequest",
"DeleteScanConfigRequest",
Expand Down
92 changes: 92 additions & 0 deletions google/cloud/websecurityscanner_v1/types/scan_run_log.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# -*- coding: utf-8 -*-
# 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.
#
import proto # type: ignore

from google.cloud.websecurityscanner_v1.types import scan_run, scan_run_error_trace

__protobuf__ = proto.module(
package="google.cloud.websecurityscanner.v1",
manifest={
"ScanRunLog",
},
)


class ScanRunLog(proto.Message):
r"""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

Attributes:
summary (str):
Human friendly message about the event.
name (str):
The resource name of the ScanRun AACF being
logged.
execution_state (google.cloud.websecurityscanner_v1.types.ScanRun.ExecutionState):
The execution state of the ScanRun.
result_state (google.cloud.websecurityscanner_v1.types.ScanRun.ResultState):
The result state of the ScanRun.
urls_crawled_count (int):

urls_tested_count (int):

has_findings (bool):

error_trace (google.cloud.websecurityscanner_v1.types.ScanRunErrorTrace):

"""

summary = proto.Field(
proto.STRING,
number=1,
)
name = proto.Field(
proto.STRING,
number=2,
)
execution_state = proto.Field(
proto.ENUM,
number=3,
enum=scan_run.ScanRun.ExecutionState,
)
result_state = proto.Field(
proto.ENUM,
number=4,
enum=scan_run.ScanRun.ResultState,
)
urls_crawled_count = proto.Field(
proto.INT64,
number=5,
)
urls_tested_count = proto.Field(
proto.INT64,
number=6,
)
has_findings = proto.Field(
proto.BOOL,
number=7,
)
error_trace = proto.Field(
proto.MESSAGE,
number=8,
message=scan_run_error_trace.ScanRunErrorTrace,
)


__all__ = tuple(sorted(__protobuf__.manifest))
0