Class WebSecurityScannerClient (1.0.0)

WebSecurityScannerClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.transports.base.WebSecurityScannerTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-websecurityscanner/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

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.

Methods

WebSecurityScannerClient

WebSecurityScannerClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.transports.base.WebSecurityScannerTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-websecurityscanner/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the web security scanner client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .WebSecurityScannerTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

create_scan_config

create_scan_config(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.CreateScanConfigRequest] = None, *, parent: Optional[str] = None, scan_config: Optional[google.cloud.websecurityscanner_v1alpha.types.scan_config.ScanConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new ScanConfig.

Parameters
Name	Description
`request`	`.web_security_scanner.CreateScanConfigRequest` The request object. Request for the `CreateScanConfig` method.
`parent`	`str` Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`scan_config`	`.gcw_scan_config.ScanConfig` Required. The ScanConfig to be created. This corresponds to the `scan_config` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.gcw_scan_config.ScanConfig`	A ScanConfig resource contains the configurations to launch a scan. next id: 12

delete_scan_config

delete_scan_config(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.DeleteScanConfigRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing ScanConfig and its child resources.

Parameters
Name	Description
`request`	`.web_security_scanner.DeleteScanConfigRequest` The request object. Request for the `DeleteScanConfig` method.
`name`	`str` Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

get_finding

get_finding(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.GetFindingRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a Finding.

Parameters
Name	Description
`request`	`.web_security_scanner.GetFindingRequest` The request object. Request for the `GetFinding` method.
`name`	`str` Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.finding.Finding`	A Finding resource represents a vulnerability instance identified during a ScanRun.

get_scan_config

get_scan_config(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.GetScanConfigRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a ScanConfig.

Parameters
Name	Description
`request`	`.web_security_scanner.GetScanConfigRequest` The request object. Request for the `GetScanConfig` method.
`name`	`str` Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.scan_config.ScanConfig`	A ScanConfig resource contains the configurations to launch a scan. next id: 12

get_scan_run

get_scan_run(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.GetScanRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a ScanRun.

Parameters
Name	Description
`request`	`.web_security_scanner.GetScanRunRequest` The request object. Request for the `GetScanRun` method.
`name`	`str` Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.scan_run.ScanRun`	A ScanRun is a output-only resource representing an actual run of the scan.

list_crawled_urls

list_crawled_urls(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListCrawledUrlsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List CrawledUrls under a given ScanRun.

Parameters
Name	Description
`request`	`.web_security_scanner.ListCrawledUrlsRequest` The request object. Request for the `ListCrawledUrls` method.
`parent`	`str` Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListCrawledUrlsPager`	Response for the `ListCrawledUrls` method. Iterating over this object will yield results and resolve additional pages automatically.

list_finding_type_stats

list_finding_type_stats(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListFindingTypeStatsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List all FindingTypeStats under a given ScanRun.

Parameters
Name	Description
`request`	`.web_security_scanner.ListFindingTypeStatsRequest` The request object. Request for the `ListFindingTypeStats` method.
`parent`	`str` Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.web_security_scanner.ListFindingTypeStatsResponse`	Response for the `ListFindingTypeStats` method.

list_findings

list_findings(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListFindingsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List Findings under a given ScanRun.

Parameters
Name	Description
`request`	`.web_security_scanner.ListFindingsRequest` The request object. Request for the `ListFindings` method.
`parent`	`str` Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`filter`	`str` Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. This corresponds to the `filter` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListFindingsPager`	Response for the `ListFindings` method. Iterating over this object will yield results and resolve additional pages automatically.

list_scan_configs

list_scan_configs(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListScanConfigsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists ScanConfigs under a given project.

Parameters
Name	Description
`request`	`.web_security_scanner.ListScanConfigsRequest` The request object. Request for the `ListScanConfigs` method.
`parent`	`str` Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListScanConfigsPager`	Response for the `ListScanConfigs` method. Iterating over this object will yield results and resolve additional pages automatically.

list_scan_runs

list_scan_runs(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListScanRunsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

Parameters
Name	Description
`request`	`.web_security_scanner.ListScanRunsRequest` The request object. Request for the `ListScanRuns` method.
`parent`	`str` Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListScanRunsPager`	Response for the `ListScanRuns` method. Iterating over this object will yield results and resolve additional pages automatically.

parse_scan_config_path

parse_scan_config_path(path: str)

Parse a scan_config path into its component segments.

parse_scan_run_path

parse_scan_run_path(path: str)

Parse a scan_run path into its component segments.

scan_config_path

scan_config_path(project: str, scan_config: str)

Return a fully-qualified scan_config string.

scan_run_path

scan_run_path(project: str, scan_config: str, scan_run: str)

Return a fully-qualified scan_run string.

start_scan_run

start_scan_run(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.StartScanRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Start a ScanRun according to the given ScanConfig.

Parameters
Name	Description
`request`	`.web_security_scanner.StartScanRunRequest` The request object. Request for the `StartScanRun` method.
`name`	`str` Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.scan_run.ScanRun`	A ScanRun is a output-only resource representing an actual run of the scan.

stop_scan_run

stop_scan_run(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.StopScanRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
Name	Description
`request`	`.web_security_scanner.StopScanRunRequest` The request object. Request for the `StopScanRun` method.
`name`	`str` Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.scan_run.ScanRun`	A ScanRun is a output-only resource representing an actual run of the scan.

update_scan_config

update_scan_config(request: Optional[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.UpdateScanConfigRequest] = None, *, scan_config: Optional[google.cloud.websecurityscanner_v1alpha.types.scan_config.ScanConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a ScanConfig. This method support partial update of a ScanConfig.

Parameters
Name	Description
`request`	`.web_security_scanner.UpdateScanConfigRequest` The request object. Request for the `UpdateScanConfigRequest` method.
`scan_config`	`.gcw_scan_config.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. This corresponds to the `scan_config` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`.field_mask.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 This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.gcw_scan_config.ScanConfig`	A ScanConfig resource contains the configurations to launch a scan. next id: 12