Class WebSecurityScannerClient (0.4.1)

WebSecurityScannerClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=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.

Inheritance

builtins.object > google.cloud.websecurityscanner_v1alpha.gapic.web_security_scanner_client.WebSecurityScannerClient > WebSecurityScannerClient

Methods

WebSecurityScannerClient

WebSecurityScannerClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters

Name	Description
channel	`grpc.Channel` DEPRECATED. A `Channel` instance through which to make calls. This argument is mutually exclusive with `credentials`; providing both will raise an exception.
credentials	`google.auth.credentials.Credentials` The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to `transport`; doing so will raise an exception.
client_config	`dict` DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
client_info	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.
client_options	`Union[dict, google.api_core.client_options.ClientOptions]` Client options used to set user options on the client. API Endpoint should be set through client_options.

create_scan_config

create_scan_config(parent, scan_config, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a new ScanConfig.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

parent = client.project_path('[PROJECT]')

TODO: Initialize scan_config:

scan_config = {}

response = client.create_scan_config(parent, scan_config)

Parameters

Name	Description
parent	`str` Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.
scan_config	`Union[dict, ScanConfig]` Required. The ScanConfig to be created. If a dict is provided, it must be of the same form as the protobuf message ScanConfig
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_scan_config

delete_scan_config(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes an existing ScanConfig and its child resources.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

name = client.scan_config_path('[PROJECT]', '[SCAN_CONFIG]')

client.delete_scan_config(name)

Parameters

Name	Description
name	`str` Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

finding_path

finding_path(project, scan_config, scan_run, finding)

Return a fully-qualified finding string.

from_service_account_file

from_service_account_file(filename, *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
WebSecurityScannerClient	The constructed client.

from_service_account_json

from_service_account_json(filename, *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
WebSecurityScannerClient	The constructed client.

get_finding

get_finding(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a Finding.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

name = client.finding_path('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]', '[FINDING]')

response = client.get_finding(name)

Parameters

Name	Description
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}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

get_scan_config

get_scan_config(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a ScanConfig.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

name = client.scan_config_path('[PROJECT]', '[SCAN_CONFIG]')

response = client.get_scan_config(name)

Parameters

Name	Description
name	`str` Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

get_scan_run

get_scan_run(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a ScanRun.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

name = client.scan_run_path('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]')

response = client.get_scan_run(name)

Parameters

Name	Description
name	`str` Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_crawled_urls

list_crawled_urls(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

List CrawledUrls under a given ScanRun.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

parent = client.scan_run_path('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]')

Iterate over all results

for element in client.list_crawled_urls(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_crawled_urls(parent).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
parent	`str` Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
page_size	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_finding_type_stats

list_finding_type_stats(parent, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

List all FindingTypeStats under a given ScanRun.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

parent = client.scan_run_path('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]')

response = client.list_finding_type_stats(parent)

Parameters

Name	Description
parent	`str` Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_findings

list_findings(parent, filter_, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

List Findings under a given ScanRun.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

parent = client.scan_run_path('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]')

TODO: Initialize filter_:

filter_ = ''

Iterate over all results

for element in client.list_findings(parent, filter_): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_findings(parent, filter_).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
parent	`str` Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
filter_	`str` Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.
page_size	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_scan_configs

list_scan_configs(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists ScanConfigs under a given project.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

parent = client.project_path('[PROJECT]')

Iterate over all results

for element in client.list_scan_configs(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_scan_configs(parent).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
parent	`str` Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.
page_size	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_scan_runs

list_scan_runs(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

parent = client.scan_config_path('[PROJECT]', '[SCAN_CONFIG]')

Iterate over all results

for element in client.list_scan_runs(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_scan_runs(parent).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
parent	`str` Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.
page_size	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

project_path

project_path(project)

Return a fully-qualified project string.

scan_config_path

scan_config_path(project, scan_config)

Return a fully-qualified scan_config string.

scan_run_path

scan_run_path(project, scan_config, scan_run)

Return a fully-qualified scan_run string.

start_scan_run

start_scan_run(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Start a ScanRun according to the given ScanConfig.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

name = client.scan_config_path('[PROJECT]', '[SCAN_CONFIG]')

response = client.start_scan_run(name)

Parameters

Name	Description
name	`str` Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

stop_scan_run

stop_scan_run(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Stops a ScanRun. The stopped ScanRun is returned.

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

name = client.scan_run_path('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]')

response = client.stop_scan_run(name)

Parameters

Name	Description
name	`str` Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

update_scan_config

update_scan_config(scan_config, update_mask, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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

.. rubric:: Example

from google.cloud import websecurityscanner_v1alpha

client = websecurityscanner_v1alpha.WebSecurityScannerClient()

TODO: Initialize scan_config:

scan_config = {}

TODO: Initialize update_mask:

update_mask = {}

response = client.update_scan_config(scan_config, update_mask)

Parameters

Name	Description
scan_config	`Union[dict, 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. If a dict is provided, it must be of the same form as the protobuf message ScanConfig
update_mask	`Union[dict, 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 If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
metadata	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

Class WebSecurityScannerClient (0.4.1)

Inheritance

Methods

WebSecurityScannerClient

create_scan_config

TODO: Initialize `scan_config`:

delete_scan_config

finding_path

from_service_account_file

from_service_account_json

get_finding

get_scan_config

get_scan_run

list_crawled_urls

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_finding_type_stats

list_findings

TODO: Initialize `filter_`:

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_scan_configs

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_scan_runs

Iterate over all results

Alternatively:

Iterate over results one page at a time

project_path

scan_config_path

scan_run_path

start_scan_run

stop_scan_run

update_scan_config

TODO: Initialize `scan_config`:

TODO: Initialize `update_mask`:

Class WebSecurityScannerClient (0.4.1)

Inheritance

Methods

WebSecurityScannerClient

create_scan_config

TODO: Initialize scan_config:

delete_scan_config

finding_path

from_service_account_file

from_service_account_json

get_finding

get_scan_config

get_scan_run

list_crawled_urls

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_finding_type_stats

list_findings

TODO: Initialize filter_:

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_scan_configs

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_scan_runs

Iterate over all results

Alternatively:

Iterate over results one page at a time

project_path

scan_config_path

scan_run_path

start_scan_run

stop_scan_run

update_scan_config

TODO: Initialize scan_config:

TODO: Initialize update_mask:

TODO: Initialize `scan_config`:

TODO: Initialize `filter_`:

TODO: Initialize `scan_config`:

TODO: Initialize `update_mask`: