Class WebSecurityScannerAsyncClient (1.16.0) 

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

Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
WebSecurityScannerTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

WebSecurityScannerAsyncClient

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

Instantiates the web security scanner async client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport 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.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_scan_config

create_scan_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.CreateScanConfigRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.scan_config.ScanConfig

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.CreateScanConfigRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.CreateScanConfigRequest, dict]]

The request object. Request for the CreateScanConfig method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ScanConfig A ScanConfig resource contains the configurations to launch a scan.

delete_scan_config

delete_scan_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.DeleteScanConfigRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.DeleteScanConfigRequest(
    )

    # Make the request
    await client.delete_scan_config(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.DeleteScanConfigRequest, dict]]

The request object. Request for the DeleteScanConfig method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

finding_path

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

Returns a fully-qualified finding string.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
WebSecurityScannerAsyncClient The constructed client.

from_service_account_info

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

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

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
WebSecurityScannerAsyncClient The constructed client.

from_service_account_json

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
WebSecurityScannerAsyncClient The constructed client.

get_finding

get_finding(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.GetFindingRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.finding.Finding

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.GetFindingRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.GetFindingRequest, dict]]

The request object. Request for the GetFinding method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.Finding A Finding resource represents a vulnerability instance identified during a ScanRun.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_scan_config

get_scan_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.GetScanConfigRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.scan_config.ScanConfig

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.GetScanConfigRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.GetScanConfigRequest, dict]]

The request object. Request for the GetScanConfig method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ScanConfig A ScanConfig resource contains the configurations to launch a scan.

get_scan_run

get_scan_run(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.GetScanRunRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.scan_run.ScanRun

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.GetScanRunRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.GetScanRunRequest, dict]]

The request object. Request for the GetScanRun method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ScanRun A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.websecurityscanner_v1.services.web_security_scanner.transports.base.WebSecurityScannerTransport
]

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

The name of the desired transport. If none is provided, then the first transport in the registry is used.

list_crawled_urls

list_crawled_urls(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.ListCrawledUrlsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPager
)

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.ListCrawledUrlsRequest(
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.ListCrawledUrlsRequest, dict]]

The request object. Request for the ListCrawledUrls method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListCrawledUrlsAsyncPager Response for the ListCrawledUrls method. Iterating over this object will yield results and resolve additional pages automatically.

list_finding_type_stats

list_finding_type_stats(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.ListFindingTypeStatsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.websecurityscanner_v1.types.web_security_scanner.ListFindingTypeStatsResponse
)

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.ListFindingTypeStatsRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.ListFindingTypeStatsRequest, dict]]

The request object. Request for the ListFindingTypeStats method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ListFindingTypeStatsResponse Response for the ListFindingTypeStats method.

list_findings

list_findings(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.ListFindingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListFindingsAsyncPager
)

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.ListFindingsRequest(
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.ListFindingsRequest, dict]]

The request object. Request for the ListFindings method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListFindingsAsyncPager Response for the ListFindings method. Iterating over this object will yield results and resolve additional pages automatically.

list_scan_configs

list_scan_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.ListScanConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListScanConfigsAsyncPager
)

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.ListScanConfigsRequest(
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.ListScanConfigsRequest, dict]]

The request object. Request for the ListScanConfigs method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListScanConfigsAsyncPager Response for the ListScanConfigs method. Iterating over this object will yield results and resolve additional pages automatically.

list_scan_runs

list_scan_runs(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.ListScanRunsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListScanRunsAsyncPager
)

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.ListScanRunsRequest(
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.ListScanRunsRequest, dict]]

The request object. Request for the ListScanRuns method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.services.web_security_scanner.pagers.ListScanRunsAsyncPager Response for the ListScanRuns method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_finding_path

parse_finding_path(path: str) -> typing.Dict[str, str]

Parses a finding path into its component segments.

start_scan_run

start_scan_run(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.StartScanRunRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.scan_run.ScanRun

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.StartScanRunRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.StartScanRunRequest, dict]]

The request object. Request for the StartScanRun method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ScanRun A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

stop_scan_run

stop_scan_run(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.StopScanRunRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.scan_run.ScanRun

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.StopScanRunRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.StopScanRunRequest, dict]]

The request object. Request for the StopScanRun method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ScanRun A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

update_scan_config

update_scan_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.websecurityscanner_v1.types.web_security_scanner.UpdateScanConfigRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.websecurityscanner_v1.types.scan_config.ScanConfig

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_v1

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

    # Initialize request argument(s)
    request = websecurityscanner_v1.UpdateScanConfigRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.websecurityscanner_v1.types.UpdateScanConfigRequest, dict]]

The request object. Request for the UpdateScanConfigRequest method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.websecurityscanner_v1.types.ScanConfig A ScanConfig resource contains the configurations to launch a scan.