WebSecurityScannerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.transports.base.WebSecurityScannerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
WebSecurityScannerTransport | The transport used by the client instance. |
Methods
WebSecurityScannerAsyncClient
WebSecurityScannerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.transports.base.WebSecurityScannerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the web security scanner client.
| 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,
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 |
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Creates a new ScanConfig.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_create_scan_config():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
scan_config = websecurityscanner_v1alpha.ScanConfig()
scan_config.display_name = "display_name_value"
scan_config.starting_urls = ['starting_urls_value1', 'starting_urls_value2']
request = websecurityscanner_v1alpha.CreateScanConfigRequest(
parent="parent_value",
scan_config=scan_config,
)
# Make the request
response = await client.create_scan_config(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.CreateScanConfigRequest, dict]]
The request object. Request for the |
parent |
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 |
scan_config |
ScanConfig
Required. The ScanConfig to be created. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ScanConfig | A 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deletes an existing ScanConfig and its child resources.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_delete_scan_config():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.DeleteScanConfigRequest(
name="name_value",
)
# Make the request
await client.delete_scan_config(request=request)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.DeleteScanConfigRequest, dict]]
The request object. Request for the |
name |
Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the |
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.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
WebSecurityScannerAsyncClient | The 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.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
WebSecurityScannerAsyncClient | 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.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
WebSecurityScannerAsyncClient | The 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets a Finding.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_get_finding():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.GetFindingRequest(
name="name_value",
)
# Make the request
response = await client.get_finding(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.GetFindingRequest, dict]]
The request object. Request for the |
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}'. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.Finding | A Finding resource represents a vulnerability instance identified during a ScanRun. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets a ScanConfig.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_get_scan_config():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.GetScanConfigRequest(
name="name_value",
)
# Make the request
response = await client.get_scan_config(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.GetScanConfigRequest, dict]]
The request object. Request for the |
name |
Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ScanConfig | A 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets a ScanRun.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_get_scan_run():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.GetScanRunRequest(
name="name_value",
)
# Make the request
response = await client.get_scan_run(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.GetScanRunRequest, dict]]
The request object. Request for the |
name |
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 |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ScanRun | A ScanRun is a output-only resource representing an actual run of the scan. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List CrawledUrls under a given ScanRun.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_list_crawled_urls():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.ListCrawledUrlsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_crawled_urls(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListCrawledUrlsRequest, dict]]
The request object. Request for the |
parent |
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 |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPager | 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[Union[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListFindingTypeStatsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List all FindingTypeStats under a given ScanRun.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_list_finding_type_stats():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.ListFindingTypeStatsRequest(
parent="parent_value",
)
# Make the request
response = await client.list_finding_type_stats(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListFindingTypeStatsRequest, dict]]
The request object. Request for the |
parent |
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 |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ListFindingTypeStatsResponse | Response 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List Findings under a given ScanRun.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_list_findings():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.ListFindingsRequest(
parent="parent_value",
filter="filter_value",
)
# Make the request
page_result = client.list_findings(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListFindingsRequest, dict]]
The request object. Request for the |
parent |
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 |
filter |
Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListFindingsAsyncPager | 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[Union[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListScanConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists ScanConfigs under a given project.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_list_scan_configs():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.ListScanConfigsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_scan_configs(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListScanConfigsRequest, dict]]
The request object. Request for the |
parent |
Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListScanConfigsAsyncPager | 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[Union[google.cloud.websecurityscanner_v1alpha.types.web_security_scanner.ListScanRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_list_scan_runs():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.ListScanRunsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_scan_runs(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListScanRunsRequest, dict]]
The request object. Request for the |
parent |
Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.services.web_security_scanner.pagers.ListScanRunsAsyncPager | Response 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.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_finding_path
parse_finding_path(path: str)Parses a finding path into its component segments.
parse_scan_config_path
parse_scan_config_path(path: str)Parses a scan_config path into its component segments.
parse_scan_run_path
parse_scan_run_path(path: str)Parses a scan_run path into its component segments.
scan_config_path
scan_config_path(project: str, scan_config: str)Returns a fully-qualified scan_config string.
scan_run_path
scan_run_path(project: str, scan_config: str, scan_run: str)Returns a fully-qualified scan_run string.
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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Start a ScanRun according to the given ScanConfig.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_start_scan_run():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.StartScanRunRequest(
name="name_value",
)
# Make the request
response = await client.start_scan_run(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.StartScanRunRequest, dict]]
The request object. Request for the |
name |
Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. This corresponds to the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ScanRun | A 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Stops a ScanRun. The stopped ScanRun is returned.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_stop_scan_run():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
request = websecurityscanner_v1alpha.StopScanRunRequest(
name="name_value",
)
# Make the request
response = await client.stop_scan_run(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.StopScanRunRequest, dict]]
The request object. Request for the |
name |
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 |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ScanRun | A 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Updates a ScanConfig. This method support partial update of a ScanConfig.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha
async def sample_update_scan_config():
# Create a client
client = websecurityscanner_v1alpha.WebSecurityScannerAsyncClient()
# Initialize request argument(s)
scan_config = websecurityscanner_v1alpha.ScanConfig()
scan_config.display_name = "display_name_value"
scan_config.starting_urls = ['starting_urls_value1', 'starting_urls_value2']
request = websecurityscanner_v1alpha.UpdateScanConfigRequest(
scan_config=scan_config,
)
# Make the request
response = await client.update_scan_config(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Optional[Union[google.cloud.websecurityscanner_v1alpha.types.UpdateScanConfigRequest, dict]]
The request object. Request for the |
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 |
update_mask |
Required. The update mask applies to the resource. For the |
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. |
| Type | Description |
google.cloud.websecurityscanner_v1alpha.types.ScanConfig | A ScanConfig resource contains the configurations to launch a scan. next id: 12 |