Class WebSecurityScannerClient (1.12.2)

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.

Returns the transport used by the client instance.

Instantiates the web security scanner client.

Releases underlying transport's resources.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a new ScanConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

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

    # Handle the response
    print(response)

Deletes an existing ScanConfig and its child resources.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

Returns a fully-qualified finding string.

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

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

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

Gets a Finding.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

    # Handle the response
    print(response)

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.

Gets a ScanConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

    # Handle the response
    print(response)

Gets a ScanRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

    # Handle the response
    print(response)

List CrawledUrls under a given ScanRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

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

List all FindingTypeStats under a given ScanRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

    # Handle the response
    print(response)

List Findings under a given ScanRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

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

Lists ScanConfigs under a given project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

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

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a finding path into its component segments.

Parses a scan_config path into its component segments.

Parses a scan_run path into its component segments.

Returns a fully-qualified scan_config string.

Returns a fully-qualified scan_run string.

Start a ScanRun according to the given ScanConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

    # Handle the response
    print(response)

Stops a ScanRun. The stopped ScanRun is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

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

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import websecurityscanner_v1alpha

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

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

    request = websecurityscanner_v1alpha.UpdateScanConfigRequest(
        scan_config=scan_config,
    )

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

    # Handle the response
    print(response)