Package Classes (1.16.0)

Summary of entries of Classes for websecurityscanner.

Classes

WebSecurityScannerAsyncClient

Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

WebSecurityScannerClient

Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

ListCrawledUrlsAsyncPager

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial ListCrawledUrlsResponse object, and provides an __aiter__ method to iterate through its crawled_urls field.

If there are more pages, the __aiter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCrawledUrlsPager

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial ListCrawledUrlsResponse object, and provides an __iter__ method to iterate through its crawled_urls field.

If there are more pages, the __iter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFindingsAsyncPager

A pager for iterating through list_findings requests.

This class thinly wraps an initial ListFindingsResponse object, and provides an __aiter__ method to iterate through its findings field.

If there are more pages, the __aiter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFindingsPager

A pager for iterating through list_findings requests.

This class thinly wraps an initial ListFindingsResponse object, and provides an __iter__ method to iterate through its findings field.

If there are more pages, the __iter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanConfigsAsyncPager

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial ListScanConfigsResponse object, and provides an __aiter__ method to iterate through its scan_configs field.

If there are more pages, the __aiter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanConfigsPager

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial ListScanConfigsResponse object, and provides an __iter__ method to iterate through its scan_configs field.

If there are more pages, the __iter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanRunsAsyncPager

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial ListScanRunsResponse object, and provides an __aiter__ method to iterate through its scan_runs field.

If there are more pages, the __aiter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanRunsPager

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial ListScanRunsResponse object, and provides an __iter__ method to iterate through its scan_runs field.

If there are more pages, the __iter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CrawledUrl

A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.

CreateScanConfigRequest

Request for the CreateScanConfig method.

DeleteScanConfigRequest

Request for the DeleteScanConfig method.

Finding

A Finding resource represents a vulnerability instance identified during a ScanRun.

Severity

The severity level of a vulnerability.

FindingTypeStats

A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.

Form

! Information about a vulnerability with an HTML.

GetFindingRequest

Request for the GetFinding method.

GetScanConfigRequest

Request for the GetScanConfig method.

GetScanRunRequest

Request for the GetScanRun method.

ListCrawledUrlsRequest

Request for the ListCrawledUrls method.

ListCrawledUrlsResponse

Response for the ListCrawledUrls method.

ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method.

ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method.

ListFindingsRequest

Request for the ListFindings method.

ListFindingsResponse

Response for the ListFindings method.

ListScanConfigsRequest

Request for the ListScanConfigs method.

ListScanConfigsResponse

Response for the ListScanConfigs method.

ListScanRunsRequest

Request for the ListScanRuns method.

ListScanRunsResponse

Response for the ListScanRuns method.

OutdatedLibrary

Information reported for an outdated library.

ScanConfig

A ScanConfig resource contains the configurations to launch a scan.

Authentication

Scan authentication configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomAccount

Describes authentication configuration that uses a custom account.

GoogleAccount

Describes authentication configuration that uses a Google account.

IapCredential

Describes authentication configuration for Identity-Aware-Proxy (IAP).

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IapTestServiceAccountInfo

Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

ExportToSecurityCommandCenter

Controls export of scan configurations and results to Security Command Center.

RiskLevel

Scan risk levels supported by Web Security Scanner. LOW impact scanning will minimize requests with the potential to modify data. To achieve the maximum scan coverage, NORMAL risk level is recommended.

Schedule

Scan schedule configuration.

UserAgent

Type of user agents used for scanning.

ScanConfigError

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.

Code

Output only. Defines an error reason code. Next id: 44

ScanRun

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

ExecutionState

Types of ScanRun execution state.

ResultState

Types of ScanRun result state.

ScanRunErrorTrace

Output only. Defines an error trace message for a ScanRun.

Code

Output only. Defines an error reason code. Next id: 8

ScanRunLog

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

ScanRunWarningTrace

Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

Code

Output only. Defines a warning message code. Next id: 6

StartScanRunRequest

Request for the StartScanRun method.

StopScanRunRequest

Request for the StopScanRun method.

UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method.

ViolatingResource

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

VulnerableHeaders

Information about vulnerable or missing HTTP Headers.

Describes a HTTP Header.

VulnerableParameters

Information about vulnerable request parameters.

Xss

Information reported for an XSS.

AttackVector

Types of XSS attack vector.

Xxe

Information reported for an XXE.

Location

Locations within a request where XML was substituted.

WebSecurityScannerAsyncClient

Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

WebSecurityScannerClient

Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

ListCrawledUrlsAsyncPager

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial ListCrawledUrlsResponse object, and provides an __aiter__ method to iterate through its crawled_urls field.

If there are more pages, the __aiter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCrawledUrlsPager

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial ListCrawledUrlsResponse object, and provides an __iter__ method to iterate through its crawled_urls field.

If there are more pages, the __iter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFindingsAsyncPager

A pager for iterating through list_findings requests.

This class thinly wraps an initial ListFindingsResponse object, and provides an __aiter__ method to iterate through its findings field.

If there are more pages, the __aiter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFindingsPager

A pager for iterating through list_findings requests.

This class thinly wraps an initial ListFindingsResponse object, and provides an __iter__ method to iterate through its findings field.

If there are more pages, the __iter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanConfigsAsyncPager

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial ListScanConfigsResponse object, and provides an __aiter__ method to iterate through its scan_configs field.

If there are more pages, the __aiter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanConfigsPager

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial ListScanConfigsResponse object, and provides an __iter__ method to iterate through its scan_configs field.

If there are more pages, the __iter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanRunsAsyncPager

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial ListScanRunsResponse object, and provides an __aiter__ method to iterate through its scan_runs field.

If there are more pages, the __aiter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanRunsPager

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial ListScanRunsResponse object, and provides an __iter__ method to iterate through its scan_runs field.

If there are more pages, the __iter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CrawledUrl

A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.

CreateScanConfigRequest

Request for the CreateScanConfig method.

DeleteScanConfigRequest

Request for the DeleteScanConfig method.

Finding

A Finding resource represents a vulnerability instance identified during a ScanRun.

FindingType

Types of Findings.

FindingTypeStats

A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.

GetFindingRequest

Request for the GetFinding method.

GetScanConfigRequest

Request for the GetScanConfig method.

GetScanRunRequest

Request for the GetScanRun method.

ListCrawledUrlsRequest

Request for the ListCrawledUrls method.

ListCrawledUrlsResponse

Response for the ListCrawledUrls method.

ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method.

ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method.

ListFindingsRequest

Request for the ListFindings method.

ListFindingsResponse

Response for the ListFindings method.

ListScanConfigsRequest

Request for the ListScanConfigs method.

ListScanConfigsResponse

Response for the ListScanConfigs method.

ListScanRunsRequest

Request for the ListScanRuns method.

ListScanRunsResponse

Response for the ListScanRuns method.

OutdatedLibrary

Information reported for an outdated library.

ScanConfig

A ScanConfig resource contains the configurations to launch a scan. next id: 12

Authentication

Scan authentication configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomAccount

Describes authentication configuration that uses a custom account.

GoogleAccount

Describes authentication configuration that uses a Google account.

Schedule

Scan schedule configuration.

TargetPlatform

Cloud platforms supported by Cloud Web Security Scanner.

UserAgent

Type of user agents used for scanning.

ScanRun

A ScanRun is a output-only resource representing an actual run of the scan.

ExecutionState

Types of ScanRun execution state.

ResultState

Types of ScanRun result state.

StartScanRunRequest

Request for the StartScanRun method.

StopScanRunRequest

Request for the StopScanRun method.

UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method.

ViolatingResource

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

VulnerableHeaders

Information about vulnerable or missing HTTP Headers.

Header

Describes a HTTP Header.

VulnerableParameters

Information about vulnerable request parameters.

Xss

Information reported for an XSS.

WebSecurityScannerAsyncClient

Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

WebSecurityScannerClient

Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

ListCrawledUrlsAsyncPager

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial ListCrawledUrlsResponse object, and provides an __aiter__ method to iterate through its crawled_urls field.

If there are more pages, the __aiter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCrawledUrlsPager

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial ListCrawledUrlsResponse object, and provides an __iter__ method to iterate through its crawled_urls field.

If there are more pages, the __iter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFindingsAsyncPager

A pager for iterating through list_findings requests.

This class thinly wraps an initial ListFindingsResponse object, and provides an __aiter__ method to iterate through its findings field.

If there are more pages, the __aiter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFindingsPager

A pager for iterating through list_findings requests.

This class thinly wraps an initial ListFindingsResponse object, and provides an __iter__ method to iterate through its findings field.

If there are more pages, the __iter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanConfigsAsyncPager

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial ListScanConfigsResponse object, and provides an __aiter__ method to iterate through its scan_configs field.

If there are more pages, the __aiter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanConfigsPager

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial ListScanConfigsResponse object, and provides an __iter__ method to iterate through its scan_configs field.

If there are more pages, the __iter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanRunsAsyncPager

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial ListScanRunsResponse object, and provides an __aiter__ method to iterate through its scan_runs field.

If there are more pages, the __aiter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScanRunsPager

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial ListScanRunsResponse object, and provides an __iter__ method to iterate through its scan_runs field.

If there are more pages, the __iter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CrawledUrl

A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.

CreateScanConfigRequest

Request for the CreateScanConfig method.

DeleteScanConfigRequest

Request for the DeleteScanConfig method.

Finding

A Finding resource represents a vulnerability instance identified during a ScanRun.

FindingTypeStats

A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.

Form

! Information about a vulnerability with an HTML.

GetFindingRequest

Request for the GetFinding method.

GetScanConfigRequest

Request for the GetScanConfig method.

GetScanRunRequest

Request for the GetScanRun method.

ListCrawledUrlsRequest

Request for the ListCrawledUrls method.

ListCrawledUrlsResponse

Response for the ListCrawledUrls method.

ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method.

ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method.

ListFindingsRequest

Request for the ListFindings method.

ListFindingsResponse

Response for the ListFindings method.

ListScanConfigsRequest

Request for the ListScanConfigs method.

ListScanConfigsResponse

Response for the ListScanConfigs method.

ListScanRunsRequest

Request for the ListScanRuns method.

ListScanRunsResponse

Response for the ListScanRuns method.

OutdatedLibrary

Information reported for an outdated library.

ScanConfig

A ScanConfig resource contains the configurations to launch a scan.

Authentication

Scan authentication configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomAccount

Describes authentication configuration that uses a custom account.

GoogleAccount

Describes authentication configuration that uses a Google account.

ExportToSecurityCommandCenter

Controls export of scan configurations and results to Cloud Security Command Center.

RiskLevel

Scan risk levels supported by Cloud Web Security Scanner. LOW impact scanning will minimize requests with the potential to modify data. To achieve the maximum scan coverage, NORMAL risk level is recommended.

Schedule

Scan schedule configuration.

TargetPlatform

Cloud platforms supported by Cloud Web Security Scanner.

UserAgent

Type of user agents used for scanning.

ScanConfigError

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.

Code

Output only. Defines an error reason code. Next id: 44

ScanRun

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

ExecutionState

Types of ScanRun execution state.

ResultState

Types of ScanRun result state.

ScanRunErrorTrace

Output only. Defines an error trace message for a ScanRun.

Code

Output only. Defines an error reason code. Next id: 7

ScanRunWarningTrace

Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

Code

Output only. Defines a warning message code. Next id: 6

StartScanRunRequest

Request for the StartScanRun method.

StopScanRunRequest

Request for the StopScanRun method.

UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method.

ViolatingResource

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

VulnerableHeaders

Information about vulnerable or missing HTTP Headers.

Header

Describes a HTTP Header.

VulnerableParameters

Information about vulnerable request parameters.

Xss

Information reported for an XSS.

Modules

pagers

API documentation for websecurityscanner_v1.services.web_security_scanner.pagers module.

pagers

API documentation for websecurityscanner_v1alpha.services.web_security_scanner.pagers module.

pagers

API documentation for websecurityscanner_v1beta.services.web_security_scanner.pagers module.