Package types (1.4.3)

Stay organized with collections Save and categorize content based on your preferences.

API documentation for websecurityscanner_v1.types package.

Classes

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. .. attribute:: parent

Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.

:type: str

DeleteScanConfigRequest

Request for the DeleteScanConfig method. .. attribute:: name

Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

:type: str

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. .. attribute:: action_uri

! The URI where to send the form when it's submitted.

:type: str

GetFindingRequest

Request for the GetFinding method. .. attribute:: name

Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.

:type: str

GetScanConfigRequest

Request for the GetScanConfig method. .. attribute:: name

Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

:type: str

GetScanRunRequest

Request for the GetScanRun method. .. attribute:: name

Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

:type: str

ListCrawledUrlsRequest

Request for the ListCrawledUrls method. .. attribute:: parent

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

:type: str

ListCrawledUrlsResponse

Response for the ListCrawledUrls method. .. attribute:: crawled_urls

The list of CrawledUrls returned.

:type: Sequence[google.cloud.websecurityscanner_v1.types.CrawledUrl]

ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method. .. attribute:: parent

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

:type: str

ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method. .. attribute:: finding_type_stats

The list of FindingTypeStats returned.

:type: Sequence[google.cloud.websecurityscanner_v1.types.FindingTypeStats]

ListFindingsRequest

Request for the ListFindings method. .. attribute:: parent

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

:type: str

ListFindingsResponse

Response for the ListFindings method. .. attribute:: findings

The list of Findings returned.

:type: Sequence[google.cloud.websecurityscanner_v1.types.Finding]

ListScanConfigsRequest

Request for the ListScanConfigs method. .. attribute:: parent

Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.

:type: str

ListScanConfigsResponse

Response for the ListScanConfigs method. .. attribute:: scan_configs

The list of ScanConfigs returned.

:type: Sequence[google.cloud.websecurityscanner_v1.types.ScanConfig]

ListScanRunsRequest

Request for the ListScanRuns method. .. attribute:: parent

Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.

:type: str

ListScanRunsResponse

Response for the ListScanRuns method. .. attribute:: scan_runs

The list of ScanRuns returned.

:type: Sequence[google.cloud.websecurityscanner_v1.types.ScanRun]

OutdatedLibrary

Information reported for an outdated library. .. attribute:: library_name

The name of the outdated library.

:type: str

ScanConfig

A ScanConfig resource contains the configurations to launch a scan.

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.

ScanRun

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

ScanRunErrorTrace

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

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.

StartScanRunRequest

Request for the StartScanRun method. .. attribute:: name

Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

:type: str

StopScanRunRequest

Request for the StopScanRun method. .. attribute:: name

Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

:type: str

UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method. .. attribute:: scan_config

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.

:type: google.cloud.websecurityscanner_v1.types.ScanConfig

ViolatingResource

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

VulnerableHeaders

Information about vulnerable or missing HTTP Headers. .. attribute:: headers

List of vulnerable headers.

:type: Sequence[google.cloud.websecurityscanner_v1.types.VulnerableHeaders.Header]

VulnerableParameters

Information about vulnerable request parameters. .. attribute:: parameter_names

The vulnerable parameter names.

:type: Sequence[str]

Xss

Information reported for an XSS. .. attribute:: stack_traces

Stack traces leading to the point where the XSS occurred.

:type: Sequence[str]