As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

WebSecurityScanner¶

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.WebSecurityScannerAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport, typing.Callable[[...], google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]¶

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.

Instantiates the web security scanner async client.

Parameters

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 (Optional[Union[str,WebSecurityScannerTransport,Callable[..., WebSecurityScannerTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the WebSecurityScannerTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.CreateScanConfigRequest, dict]] = None, *, parent: Optional[str] = None, scan_config: Optional[google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig[source]¶

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_v1beta

async def sample_create_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    scan_config = websecurityscanner_v1beta.ScanConfig()
    scan_config.display_name = "display_name_value"
    scan_config.starting_urls = ['starting_urls_value1', 'starting_urls_value2']

    request = websecurityscanner_v1beta.CreateScanConfigRequest(
        parent="parent_value",
        scan_config=scan_config,
    )

    # Make the request
    response = await client.create_scan_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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 (google.cloud.websecurityscanner_v1beta.types.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_async.AsyncRetry) – 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

A ScanConfig resource contains the configurations to launch a scan.

Return type

google.cloud.websecurityscanner_v1beta.types.ScanConfig

async delete_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.DeleteScanConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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_v1beta

async def sample_delete_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.DeleteScanConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_scan_config(request=request)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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.

static finding_path(project: str, scan_config: str, scan_run: str, finding: str) → str¶: Returns a fully-qualified finding string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

WebSecurityScannerAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

WebSecurityScannerAsyncClient

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

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

Parameters

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

The constructed client.

Return type

WebSecurityScannerAsyncClient

async get_finding(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.GetFindingRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.finding.Finding[source]¶

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_v1beta

async def sample_get_finding():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.GetFindingRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_finding(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

A Finding resource represents a vulnerability instance identified during a ScanRun.

Return type

google.cloud.websecurityscanner_v1beta.types.Finding

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.GetScanConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig[source]¶

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_v1beta

async def sample_get_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.GetScanConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_scan_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

A ScanConfig resource contains the configurations to launch a scan.

Return type

google.cloud.websecurityscanner_v1beta.types.ScanConfig

async get_scan_run(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.GetScanRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_run.ScanRun[source]¶

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_v1beta

async def sample_get_scan_run():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.GetScanRunRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_scan_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

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

Return type

google.cloud.websecurityscanner_v1beta.types.ScanRun

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_crawled_urls(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPager[source]¶

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_v1beta

async def sample_list_crawled_urls():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.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)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

Response for the ListCrawledUrls method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPager

async list_finding_type_stats(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingTypeStatsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingTypeStatsResponse[source]¶

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_v1beta

async def sample_list_finding_type_stats():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.ListFindingTypeStatsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.list_finding_type_stats(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

Response for the ListFindingTypeStats method.

Return type

google.cloud.websecurityscanner_v1beta.types.ListFindingTypeStatsResponse

async list_findings(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListFindingsAsyncPager[source]¶

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_v1beta

async def sample_list_findings():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.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)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

Response for the ListFindings method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListFindingsAsyncPager

async list_scan_configs(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanConfigsAsyncPager[source]¶

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_v1beta

async def sample_list_scan_configs():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.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)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

Response for the ListScanConfigs method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanConfigsAsyncPager

async list_scan_runs(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanRunsAsyncPager[source]¶

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_v1beta

async def sample_list_scan_runs():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.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)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

Response for the ListScanRuns method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanRunsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_finding_path(path: str) → Dict[str, str]¶: Parses a finding path into its component segments.

static parse_scan_config_path(path: str) → Dict[str, str]¶: Parses a scan_config path into its component segments.

static parse_scan_run_path(path: str) → Dict[str, str]¶: Parses a scan_run path into its component segments.

static scan_config_path(project: str, scan_config: str) → str¶: Returns a fully-qualified scan_config string.

static scan_run_path(project: str, scan_config: str, scan_run: str) → str¶: Returns a fully-qualified scan_run string.

async start_scan_run(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.StartScanRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_run.ScanRun[source]¶

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_v1beta

async def sample_start_scan_run():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.StartScanRunRequest(
        name="name_value",
    )

    # Make the request
    response = await client.start_scan_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

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

Return type

google.cloud.websecurityscanner_v1beta.types.ScanRun

async stop_scan_run(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.StopScanRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_run.ScanRun[source]¶

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_v1beta

async def sample_stop_scan_run():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.StopScanRunRequest(
        name="name_value",
    )

    # Make the request
    response = await client.stop_scan_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.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_async.AsyncRetry) – 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

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

Return type

google.cloud.websecurityscanner_v1beta.types.ScanRun

property transport: google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: WebSecurityScannerTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.UpdateScanConfigRequest, dict]] = None, *, scan_config: Optional[google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig[source]¶

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_v1beta

async def sample_update_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerAsyncClient()

    # Initialize request argument(s)
    scan_config = websecurityscanner_v1beta.ScanConfig()
    scan_config.display_name = "display_name_value"
    scan_config.starting_urls = ['starting_urls_value1', 'starting_urls_value2']

    request = websecurityscanner_v1beta.UpdateScanConfigRequest(
        scan_config=scan_config,
    )

    # Make the request
    response = await client.update_scan_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.websecurityscanner_v1beta.types.UpdateScanConfigRequest, dict]]) – The request object. Request for the UpdateScanConfigRequest method.
scan_config (google.cloud.websecurityscanner_v1beta.types.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_async.AsyncRetry) – 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

A ScanConfig resource contains the configurations to launch a scan.

Return type

google.cloud.websecurityscanner_v1beta.types.ScanConfig

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.WebSecurityScannerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport, typing.Callable[[...], google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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.

Instantiates the web security scanner client.

Parameters

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 (Optional[Union[str,WebSecurityScannerTransport,Callable[..., WebSecurityScannerTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the WebSecurityScannerTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.CreateScanConfigRequest, dict]] = None, *, parent: Optional[str] = None, scan_config: Optional[google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig[source]¶

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_v1beta

def sample_create_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    scan_config = websecurityscanner_v1beta.ScanConfig()
    scan_config.display_name = "display_name_value"
    scan_config.starting_urls = ['starting_urls_value1', 'starting_urls_value2']

    request = websecurityscanner_v1beta.CreateScanConfigRequest(
        parent="parent_value",
        scan_config=scan_config,
    )

    # Make the request
    response = client.create_scan_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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 (google.cloud.websecurityscanner_v1beta.types.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

A ScanConfig resource contains the configurations to launch a scan.

Return type

google.cloud.websecurityscanner_v1beta.types.ScanConfig

delete_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.DeleteScanConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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_v1beta

def sample_delete_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.DeleteScanConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_scan_config(request=request)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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.

static finding_path(project: str, scan_config: str, scan_run: str, finding: str) → str[source]¶: Returns a fully-qualified finding string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

WebSecurityScannerClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

WebSecurityScannerClient

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

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

Parameters

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

The constructed client.

Return type

WebSecurityScannerClient

get_finding(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.GetFindingRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.finding.Finding[source]¶

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_v1beta

def sample_get_finding():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.GetFindingRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_finding(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

A Finding resource represents a vulnerability instance identified during a ScanRun.

Return type

google.cloud.websecurityscanner_v1beta.types.Finding

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.GetScanConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig[source]¶

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_v1beta

def sample_get_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.GetScanConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_scan_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

A ScanConfig resource contains the configurations to launch a scan.

Return type

google.cloud.websecurityscanner_v1beta.types.ScanConfig

get_scan_run(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.GetScanRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_run.ScanRun[source]¶

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_v1beta

def sample_get_scan_run():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.GetScanRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_scan_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

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

Return type

google.cloud.websecurityscanner_v1beta.types.ScanRun

list_crawled_urls(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListCrawledUrlsPager[source]¶

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_v1beta

def sample_list_crawled_urls():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.ListCrawledUrlsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_crawled_urls(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

Response for the ListCrawledUrls method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListCrawledUrlsPager

list_finding_type_stats(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingTypeStatsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingTypeStatsResponse[source]¶

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_v1beta

def sample_list_finding_type_stats():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.ListFindingTypeStatsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_finding_type_stats(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

Response for the ListFindingTypeStats method.

Return type

google.cloud.websecurityscanner_v1beta.types.ListFindingTypeStatsResponse

list_findings(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListFindingsPager[source]¶

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_v1beta

def sample_list_findings():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.ListFindingsRequest(
        parent="parent_value",
        filter="filter_value",
    )

    # Make the request
    page_result = client.list_findings(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

Response for the ListFindings method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListFindingsPager

list_scan_configs(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanConfigsPager[source]¶

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_v1beta

def sample_list_scan_configs():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.ListScanConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_scan_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

Response for the ListScanConfigs method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanConfigsPager

list_scan_runs(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanRunsPager[source]¶

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_v1beta

def sample_list_scan_runs():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.ListScanRunsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_scan_runs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

Response for the ListScanRuns method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanRunsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_finding_path(path: str) → Dict[str, str][source]¶: Parses a finding path into its component segments.

static parse_scan_config_path(path: str) → Dict[str, str][source]¶: Parses a scan_config path into its component segments.

static parse_scan_run_path(path: str) → Dict[str, str][source]¶: Parses a scan_run path into its component segments.

static scan_config_path(project: str, scan_config: str) → str[source]¶: Returns a fully-qualified scan_config string.

static scan_run_path(project: str, scan_config: str, scan_run: str) → str[source]¶: Returns a fully-qualified scan_run string.

start_scan_run(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.StartScanRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_run.ScanRun[source]¶

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_v1beta

def sample_start_scan_run():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.StartScanRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.start_scan_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

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

Return type

google.cloud.websecurityscanner_v1beta.types.ScanRun

stop_scan_run(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.StopScanRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_run.ScanRun[source]¶

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_v1beta

def sample_stop_scan_run():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    request = websecurityscanner_v1beta.StopScanRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.stop_scan_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.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

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

Return type

google.cloud.websecurityscanner_v1beta.types.ScanRun

property transport: google.cloud.websecurityscanner_v1beta.services.web_security_scanner.transports.base.WebSecurityScannerTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

WebSecurityScannerTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_scan_config(request: Optional[Union[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.UpdateScanConfigRequest, dict]] = None, *, scan_config: Optional[google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.websecurityscanner_v1beta.types.scan_config.ScanConfig[source]¶

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_v1beta

def sample_update_scan_config():
    # Create a client
    client = websecurityscanner_v1beta.WebSecurityScannerClient()

    # Initialize request argument(s)
    scan_config = websecurityscanner_v1beta.ScanConfig()
    scan_config.display_name = "display_name_value"
    scan_config.starting_urls = ['starting_urls_value1', 'starting_urls_value2']

    request = websecurityscanner_v1beta.UpdateScanConfigRequest(
        scan_config=scan_config,
    )

    # Make the request
    response = client.update_scan_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.websecurityscanner_v1beta.types.UpdateScanConfigRequest, dict]) – The request object. Request for the UpdateScanConfigRequest method.
scan_config (google.cloud.websecurityscanner_v1beta.types.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

A ScanConfig resource contains the configurations to launch a scan.

Return type

google.cloud.websecurityscanner_v1beta.types.ScanConfig

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPager(method: Callable[[...], Awaitable[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsResponse]], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsResponse object, and provides an __aiter__ method to iterate through its crawled_urls field.

If there are more pages, the __aiter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListCrawledUrlsPager(method: Callable[[...], google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsResponse], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListCrawledUrlsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_crawled_urls requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsResponse object, and provides an __iter__ method to iterate through its crawled_urls field.

If there are more pages, the __iter__ method will make additional ListCrawledUrls requests and continue to iterate through the crawled_urls field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListCrawledUrlsResponse) – The initial response object.
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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListFindingsAsyncPager(method: Callable[[...], Awaitable[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsResponse]], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_findings requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListFindingsResponse object, and provides an __aiter__ method to iterate through its findings field.

If there are more pages, the __aiter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListFindingsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListFindingsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListFindingsPager(method: Callable[[...], google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsResponse], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListFindingsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_findings requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListFindingsResponse object, and provides an __iter__ method to iterate through its findings field.

If there are more pages, the __iter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListFindingsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListFindingsResponse) – The initial response object.
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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsResponse]], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListScanConfigsResponse object, and provides an __aiter__ method to iterate through its scan_configs field.

If there are more pages, the __aiter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListScanConfigsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListScanConfigsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanConfigsPager(method: Callable[[...], google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsResponse], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_scan_configs requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListScanConfigsResponse object, and provides an __iter__ method to iterate through its scan_configs field.

If there are more pages, the __iter__ method will make additional ListScanConfigs requests and continue to iterate through the scan_configs field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListScanConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListScanConfigsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListScanConfigsResponse) – The initial response object.
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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanRunsAsyncPager(method: Callable[[...], Awaitable[google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsResponse]], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListScanRunsResponse object, and provides an __aiter__ method to iterate through its scan_runs field.

If there are more pages, the __aiter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListScanRunsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListScanRunsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.websecurityscanner_v1beta.services.web_security_scanner.pagers.ListScanRunsPager(method: Callable[[...], google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsResponse], request: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsRequest, response: google.cloud.websecurityscanner_v1beta.types.web_security_scanner.ListScanRunsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_scan_runs requests.

This class thinly wraps an initial google.cloud.websecurityscanner_v1beta.types.ListScanRunsResponse object, and provides an __iter__ method to iterate through its scan_runs field.

If there are more pages, the __iter__ method will make additional ListScanRuns requests and continue to iterate through the scan_runs field on the corresponding responses.

All the usual google.cloud.websecurityscanner_v1beta.types.ListScanRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.websecurityscanner_v1beta.types.ListScanRunsRequest) – The initial request object.
response (google.cloud.websecurityscanner_v1beta.types.ListScanRunsResponse) – The initial response object.
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.

WebSecurityScanner¶

google-cloud-websecurityscanner

Navigation

Related Topics