Web Security Scanner API . projects . scanConfigs

Instance Methods

scanRuns()

Returns the scanRuns Resource.

create(parent, body=None, x__xgafv=None)

Creates a new ScanConfig.

delete(name, x__xgafv=None)

Deletes an existing ScanConfig and its child resources.

get(name, x__xgafv=None)

Gets a ScanConfig.

list(parent, pageToken=None, pageSize=None, x__xgafv=None)

Lists ScanConfigs under a given project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

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

start(name, body=None, x__xgafv=None)

Start a ScanRun according to the given ScanConfig.

Method Details

create(parent, body=None, x__xgafv=None)
Creates a new ScanConfig.

Args:
  parent: string, Required. The parent resource name where the scan is created, which should be a
project resource name in the format 'projects/{projectId}'. (required)
  body: object, The request body.
    The object takes the form of:

{ # A ScanConfig resource contains the configurations to launch a scan.
      # next id: 12
    "userAgent": "A String", # The user agent used during scanning.
    "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
      "A String",
    ],
    "displayName": "A String", # Required. The user provided display name of the ScanConfig.
    "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
        # authentication configuration during scanning.
      "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
        "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
            # and not returned in any response nor included in audit logs.
        "username": "A String", # Required. The user name of the Google account.
      },
      "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
        "username": "A String", # Required. The user name of the custom account.
        "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
            # and not returned in any response nor included in audit logs.
        "loginUrl": "A String", # Required. The login form URL of the website.
      },
    },
    "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
      "executionState": "A String", # The execution state of the ScanRun.
      "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
      "resultState": "A String", # The result state of the ScanRun. This field is only available after the
          # execution state reaches "FINISHED".
      "startTime": "A String", # The time at which the ScanRun started.
      "name": "A String", # The resource name of the ScanRun. The name follows the format of
          # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
          # The ScanRun IDs are generated by the system.
      "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
          # If the scan is in queue, the value is 0.
          # If the scan is running, the value ranges from 0 to 100.
          # If the scan is finished, the value is 100.
      "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
          # the value represents the number of URLs crawled up to now.
      "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
          # the value represents the number of URLs tested up to now. The number of
          # URLs tested is usually larger than the number URLS crawled because
          # typically a crawled URL is tested with multiple test payloads.
      "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
          # is either finished or stopped by user.
    },
    "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
      "intervalDurationDays": 42, # Required. The duration of time between executions in days.
      "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
          # refreshed by the server after each run. If unspecified, it will default
          # to current server time, which means the scan will be scheduled to start
          # immediately.
    },
    "blacklistPatterns": [ # The excluded URL patterns as described in
        # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
      "A String",
    ],
    "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
        # inclusively. If the field is unspecified or its value is set 0, server will
        # default to 15. Other values outside of [5, 20] range will be rejected with
        # INVALID_ARGUMENT error.
    "name": "A String", # The resource name of the ScanConfig. The name follows the format of
        # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
        # generated by the system.
    "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
        # will be used as a default.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ScanConfig resource contains the configurations to launch a scan.
        # next id: 12
      "userAgent": "A String", # The user agent used during scanning.
      "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
        "A String",
      ],
      "displayName": "A String", # Required. The user provided display name of the ScanConfig.
      "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
          # authentication configuration during scanning.
        "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
          "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
              # and not returned in any response nor included in audit logs.
          "username": "A String", # Required. The user name of the Google account.
        },
        "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
          "username": "A String", # Required. The user name of the custom account.
          "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
              # and not returned in any response nor included in audit logs.
          "loginUrl": "A String", # Required. The login form URL of the website.
        },
      },
      "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
        "executionState": "A String", # The execution state of the ScanRun.
        "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
        "resultState": "A String", # The result state of the ScanRun. This field is only available after the
            # execution state reaches "FINISHED".
        "startTime": "A String", # The time at which the ScanRun started.
        "name": "A String", # The resource name of the ScanRun. The name follows the format of
            # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
            # The ScanRun IDs are generated by the system.
        "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
            # If the scan is in queue, the value is 0.
            # If the scan is running, the value ranges from 0 to 100.
            # If the scan is finished, the value is 100.
        "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
            # the value represents the number of URLs crawled up to now.
        "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
            # the value represents the number of URLs tested up to now. The number of
            # URLs tested is usually larger than the number URLS crawled because
            # typically a crawled URL is tested with multiple test payloads.
        "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
            # is either finished or stopped by user.
      },
      "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
        "intervalDurationDays": 42, # Required. The duration of time between executions in days.
        "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
            # refreshed by the server after each run. If unspecified, it will default
            # to current server time, which means the scan will be scheduled to start
            # immediately.
      },
      "blacklistPatterns": [ # The excluded URL patterns as described in
          # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
        "A String",
      ],
      "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
          # inclusively. If the field is unspecified or its value is set 0, server will
          # default to 15. Other values outside of [5, 20] range will be rejected with
          # INVALID_ARGUMENT error.
      "name": "A String", # The resource name of the ScanConfig. The name follows the format of
          # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
          # generated by the system.
      "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
          # will be used as a default.
        "A String",
      ],
    }
delete(name, x__xgafv=None)
Deletes an existing ScanConfig and its child resources.

Args:
  name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the
format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None)
Gets a ScanConfig.

Args:
  name: string, Required. The resource name of the ScanConfig to be returned. The name follows the
format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ScanConfig resource contains the configurations to launch a scan.
        # next id: 12
      "userAgent": "A String", # The user agent used during scanning.
      "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
        "A String",
      ],
      "displayName": "A String", # Required. The user provided display name of the ScanConfig.
      "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
          # authentication configuration during scanning.
        "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
          "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
              # and not returned in any response nor included in audit logs.
          "username": "A String", # Required. The user name of the Google account.
        },
        "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
          "username": "A String", # Required. The user name of the custom account.
          "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
              # and not returned in any response nor included in audit logs.
          "loginUrl": "A String", # Required. The login form URL of the website.
        },
      },
      "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
        "executionState": "A String", # The execution state of the ScanRun.
        "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
        "resultState": "A String", # The result state of the ScanRun. This field is only available after the
            # execution state reaches "FINISHED".
        "startTime": "A String", # The time at which the ScanRun started.
        "name": "A String", # The resource name of the ScanRun. The name follows the format of
            # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
            # The ScanRun IDs are generated by the system.
        "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
            # If the scan is in queue, the value is 0.
            # If the scan is running, the value ranges from 0 to 100.
            # If the scan is finished, the value is 100.
        "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
            # the value represents the number of URLs crawled up to now.
        "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
            # the value represents the number of URLs tested up to now. The number of
            # URLs tested is usually larger than the number URLS crawled because
            # typically a crawled URL is tested with multiple test payloads.
        "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
            # is either finished or stopped by user.
      },
      "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
        "intervalDurationDays": 42, # Required. The duration of time between executions in days.
        "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
            # refreshed by the server after each run. If unspecified, it will default
            # to current server time, which means the scan will be scheduled to start
            # immediately.
      },
      "blacklistPatterns": [ # The excluded URL patterns as described in
          # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
        "A String",
      ],
      "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
          # inclusively. If the field is unspecified or its value is set 0, server will
          # default to 15. Other values outside of [5, 20] range will be rejected with
          # INVALID_ARGUMENT error.
      "name": "A String", # The resource name of the ScanConfig. The name follows the format of
          # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
          # generated by the system.
      "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
          # will be used as a default.
        "A String",
      ],
    }
list(parent, pageToken=None, pageSize=None, x__xgafv=None)
Lists ScanConfigs under a given project.

Args:
  parent: string, Required. The parent resource name, which should be a project resource name in the
format 'projects/{projectId}'. (required)
  pageToken: string, A token identifying a page of results to be returned. This should be a
`next_page_token` value returned from a previous List request.
If unspecified, the first page of results is returned.
  pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.
If not specified or not positive, the implementation will select a
reasonable value.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `ListScanConfigs` method.
    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
        # more results in the list.
    "scanConfigs": [ # The list of ScanConfigs returned.
      { # A ScanConfig resource contains the configurations to launch a scan.
            # next id: 12
          "userAgent": "A String", # The user agent used during scanning.
          "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
            "A String",
          ],
          "displayName": "A String", # Required. The user provided display name of the ScanConfig.
          "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
              # authentication configuration during scanning.
            "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
              "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
                  # and not returned in any response nor included in audit logs.
              "username": "A String", # Required. The user name of the Google account.
            },
            "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
              "username": "A String", # Required. The user name of the custom account.
              "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
                  # and not returned in any response nor included in audit logs.
              "loginUrl": "A String", # Required. The login form URL of the website.
            },
          },
          "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
            "executionState": "A String", # The execution state of the ScanRun.
            "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
            "resultState": "A String", # The result state of the ScanRun. This field is only available after the
                # execution state reaches "FINISHED".
            "startTime": "A String", # The time at which the ScanRun started.
            "name": "A String", # The resource name of the ScanRun. The name follows the format of
                # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
                # The ScanRun IDs are generated by the system.
            "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
                # If the scan is in queue, the value is 0.
                # If the scan is running, the value ranges from 0 to 100.
                # If the scan is finished, the value is 100.
            "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
                # the value represents the number of URLs crawled up to now.
            "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
                # the value represents the number of URLs tested up to now. The number of
                # URLs tested is usually larger than the number URLS crawled because
                # typically a crawled URL is tested with multiple test payloads.
            "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
                # is either finished or stopped by user.
          },
          "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
            "intervalDurationDays": 42, # Required. The duration of time between executions in days.
            "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
                # refreshed by the server after each run. If unspecified, it will default
                # to current server time, which means the scan will be scheduled to start
                # immediately.
          },
          "blacklistPatterns": [ # The excluded URL patterns as described in
              # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
            "A String",
          ],
          "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
              # inclusively. If the field is unspecified or its value is set 0, server will
              # default to 15. Other values outside of [5, 20] range will be rejected with
              # INVALID_ARGUMENT error.
          "name": "A String", # The resource name of the ScanConfig. The name follows the format of
              # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
              # generated by the system.
          "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
              # will be used as a default.
            "A String",
          ],
        },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a ScanConfig. This method support partial update of a ScanConfig.

Args:
  name: string, The resource name of the ScanConfig. The name follows the format of
'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
generated by the system. (required)
  body: object, The request body.
    The object takes the form of:

{ # A ScanConfig resource contains the configurations to launch a scan.
      # next id: 12
    "userAgent": "A String", # The user agent used during scanning.
    "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
      "A String",
    ],
    "displayName": "A String", # Required. The user provided display name of the ScanConfig.
    "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
        # authentication configuration during scanning.
      "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
        "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
            # and not returned in any response nor included in audit logs.
        "username": "A String", # Required. The user name of the Google account.
      },
      "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
        "username": "A String", # Required. The user name of the custom account.
        "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
            # and not returned in any response nor included in audit logs.
        "loginUrl": "A String", # Required. The login form URL of the website.
      },
    },
    "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
      "executionState": "A String", # The execution state of the ScanRun.
      "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
      "resultState": "A String", # The result state of the ScanRun. This field is only available after the
          # execution state reaches "FINISHED".
      "startTime": "A String", # The time at which the ScanRun started.
      "name": "A String", # The resource name of the ScanRun. The name follows the format of
          # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
          # The ScanRun IDs are generated by the system.
      "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
          # If the scan is in queue, the value is 0.
          # If the scan is running, the value ranges from 0 to 100.
          # If the scan is finished, the value is 100.
      "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
          # the value represents the number of URLs crawled up to now.
      "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
          # the value represents the number of URLs tested up to now. The number of
          # URLs tested is usually larger than the number URLS crawled because
          # typically a crawled URL is tested with multiple test payloads.
      "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
          # is either finished or stopped by user.
    },
    "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
      "intervalDurationDays": 42, # Required. The duration of time between executions in days.
      "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
          # refreshed by the server after each run. If unspecified, it will default
          # to current server time, which means the scan will be scheduled to start
          # immediately.
    },
    "blacklistPatterns": [ # The excluded URL patterns as described in
        # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
      "A String",
    ],
    "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
        # inclusively. If the field is unspecified or its value is set 0, server will
        # default to 15. Other values outside of [5, 20] range will be rejected with
        # INVALID_ARGUMENT error.
    "name": "A String", # The resource name of the ScanConfig. The name follows the format of
        # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
        # generated by the system.
    "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
        # will be used as a default.
      "A String",
    ],
  }

  updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ScanConfig resource contains the configurations to launch a scan.
        # next id: 12
      "userAgent": "A String", # The user agent used during scanning.
      "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
        "A String",
      ],
      "displayName": "A String", # Required. The user provided display name of the ScanConfig.
      "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
          # authentication configuration during scanning.
        "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
          "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
              # and not returned in any response nor included in audit logs.
          "username": "A String", # Required. The user name of the Google account.
        },
        "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
          "username": "A String", # Required. The user name of the custom account.
          "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
              # and not returned in any response nor included in audit logs.
          "loginUrl": "A String", # Required. The login form URL of the website.
        },
      },
      "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
        "executionState": "A String", # The execution state of the ScanRun.
        "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
        "resultState": "A String", # The result state of the ScanRun. This field is only available after the
            # execution state reaches "FINISHED".
        "startTime": "A String", # The time at which the ScanRun started.
        "name": "A String", # The resource name of the ScanRun. The name follows the format of
            # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
            # The ScanRun IDs are generated by the system.
        "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
            # If the scan is in queue, the value is 0.
            # If the scan is running, the value ranges from 0 to 100.
            # If the scan is finished, the value is 100.
        "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
            # the value represents the number of URLs crawled up to now.
        "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
            # the value represents the number of URLs tested up to now. The number of
            # URLs tested is usually larger than the number URLS crawled because
            # typically a crawled URL is tested with multiple test payloads.
        "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
            # is either finished or stopped by user.
      },
      "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
        "intervalDurationDays": 42, # Required. The duration of time between executions in days.
        "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
            # refreshed by the server after each run. If unspecified, it will default
            # to current server time, which means the scan will be scheduled to start
            # immediately.
      },
      "blacklistPatterns": [ # The excluded URL patterns as described in
          # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
        "A String",
      ],
      "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
          # inclusively. If the field is unspecified or its value is set 0, server will
          # default to 15. Other values outside of [5, 20] range will be rejected with
          # INVALID_ARGUMENT error.
      "name": "A String", # The resource name of the ScanConfig. The name follows the format of
          # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
          # generated by the system.
      "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
          # will be used as a default.
        "A String",
      ],
    }
start(name, body=None, x__xgafv=None)
Start a ScanRun according to the given ScanConfig.

Args:
  name: string, Required. The resource name of the ScanConfig to be used. The name follows the
format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for the `StartScanRun` method.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ScanRun is a output-only resource representing an actual run of the scan.
    "executionState": "A String", # The execution state of the ScanRun.
    "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
    "resultState": "A String", # The result state of the ScanRun. This field is only available after the
        # execution state reaches "FINISHED".
    "startTime": "A String", # The time at which the ScanRun started.
    "name": "A String", # The resource name of the ScanRun. The name follows the format of
        # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
        # The ScanRun IDs are generated by the system.
    "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
        # If the scan is in queue, the value is 0.
        # If the scan is running, the value ranges from 0 to 100.
        # If the scan is finished, the value is 100.
    "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
        # the value represents the number of URLs crawled up to now.
    "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
        # the value represents the number of URLs tested up to now. The number of
        # URLs tested is usually larger than the number URLS crawled because
        # typically a crawled URL is tested with multiple test payloads.
    "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
        # is either finished or stopped by user.
  }