Class 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.

Inheritance

builtins.object > WebSecurityScannerAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
WebSecurityScannerTransportThe transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_scan_config

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

Creates a new ScanConfig.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.CreateScanConfigRequest, dict]

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 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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ScanConfigA ScanConfig resource contains the configurations to launch a scan. next id: 12

delete_scan_config

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

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.DeleteScanConfigRequest, dict]

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.

finding_path

finding_path(project: str, scan_config: str, scan_run: str, finding: str)

Returns a fully-qualified finding string.

Parameters
NameDescription
project str
scan_config str
scan_run str
finding str

from_service_account_file

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

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

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
WebSecurityScannerAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
WebSecurityScannerAsyncClientThe 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.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
WebSecurityScannerAsyncClientThe constructed client.

get_finding

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

Gets a Finding.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.GetFindingRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.FindingA Finding resource represents a vulnerability instance identified during a ScanRun.

get_scan_config

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

Gets a ScanConfig.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.GetScanConfigRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ScanConfigA ScanConfig resource contains the configurations to launch a scan. next id: 12

get_scan_run

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

Gets a ScanRun.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.GetScanRunRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ScanRunA ScanRun is a output-only resource representing an actual run of the scan.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter
NameDescription
label str

list_crawled_urls

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

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.ListCrawledUrlsRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPagerResponse 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[Union[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListFindingTypeStatsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.ListFindingTypeStatsRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ListFindingTypeStatsResponseResponse for the ListFindingTypeStats method.

list_findings

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

List Findings under a given ScanRun.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.ListFindingsRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListFindingsAsyncPagerResponse for the ListFindings method. Iterating over this object will yield results and resolve additional pages automatically.

list_scan_configs

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

Lists ScanConfigs under a given project.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.ListScanConfigsRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListScanConfigsAsyncPagerResponse for the ListScanConfigs method. Iterating over this object will yield results and resolve additional pages automatically.

list_scan_runs

list_scan_runs(request: Optional[Union[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListScanRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_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
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.ListScanRunsRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListScanRunsAsyncPagerResponse for the ListScanRuns method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_finding_path

parse_finding_path(path: str)

Parses a finding path into its component segments.

Parameter
NameDescription
path str

parse_scan_config_path

parse_scan_config_path(path: str)

Parses a scan_config path into its component segments.

Parameter
NameDescription
path str

parse_scan_run_path

parse_scan_run_path(path: str)

Parses a scan_run path into its component segments.

Parameter
NameDescription
path str

scan_config_path

scan_config_path(project: str, scan_config: str)

Returns a fully-qualified scan_config string.

Parameters
NameDescription
project str
scan_config str

scan_run_path

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

Returns a fully-qualified scan_run string.

Parameters
NameDescription
project str
scan_config str
scan_run str

start_scan_run

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

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.StartScanRunRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ScanRunA ScanRun is a output-only resource representing an actual run of the scan.

stop_scan_run

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

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.StopScanRunRequest, dict]

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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ScanRunA ScanRun is a output-only resource representing an actual run of the scan.

update_scan_config

update_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.UpdateScanConfigRequest, dict]] = None, *, scan_config: Optional[google.cloud.websecurityscanner_v1alpha.types.scan_config.ScanConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_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
NameDescription
request Union[google.cloud.websecurityscanner_v1alpha.types.UpdateScanConfigRequest, dict]

The request object. Request for the UpdateScanConfigRequest method.

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 `google.protobuf.field_mask_pb2.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
TypeDescription
google.cloud.websecurityscanner_v1alpha.types.ScanConfigA ScanConfig resource contains the configurations to launch a scan. next id: 12