Returns the crawledUrls Resource.
Returns the findingTypeStats Resource.
Returns the findings Resource.
Gets a ScanRun.
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
list_next(previous_request, previous_response)
Retrieves the next page of results.
stop(name, body=None, x__xgafv=None)
Stops a ScanRun. The stopped ScanRun is returned.
get(name, x__xgafv=None)
Gets a ScanRun.
Args:
name: string, Required.
The resource name of the ScanRun to be returned. The name follows the
format of
'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
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.
# Next id: 12
"warningTraces": [ # Output only.
# A list of warnings, if such are encountered during this scan run.
{ # Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
# with useful information that helps make the scanning process more effective.
"code": "A String", # Output only.
# Indicates the warning code.
},
],
"name": "A String", # Output only.
# 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.
"executionState": "A String", # Output only.
# The execution state of the ScanRun.
"urlsTestedCount": "A String", # Output only.
# 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.
"progressPercent": 42, # Output only.
# 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.
"errorTrace": { # Output only. # Output only.
# If result_state is an ERROR, this field provides the primary reason for
# scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
"mostCommonHttpErrorCode": 42, # Output only.
# If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
"code": "A String", # Output only.
# Indicates the error reason code.
"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
# If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
"code": "A String", # Output only.
# Indicates the reason code for a configuration failure.
"fieldName": "A String", # Output only.
# Indicates the full name of the ScanConfig field that triggers this error,
# for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
},
},
"resultState": "A String", # Output only.
# The result state of the ScanRun. This field is only available after the
# execution state reaches "FINISHED".
"startTime": "A String", # Output only.
# The time at which the ScanRun started.
"endTime": "A String", # Output only.
# The time at which the ScanRun reached termination state - that the ScanRun
# is either finished or stopped by user.
"hasVulnerabilities": True or False, # Output only.
# Whether the scan run has found any vulnerabilities.
"urlsCrawledCount": "A String", # Output only.
# 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.
}
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
stop time.
Args:
parent: string, Required.
The parent resource name, which should be a scan resource name in the
format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
If not specified or not positive, the implementation will select a
reasonable value.
Returns:
An object of the form:
{ # Response for the `ListScanRuns` method.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
"scanRuns": [ # The list of ScanRuns returned.
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
"warningTraces": [ # Output only.
# A list of warnings, if such are encountered during this scan run.
{ # Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
# with useful information that helps make the scanning process more effective.
"code": "A String", # Output only.
# Indicates the warning code.
},
],
"name": "A String", # Output only.
# 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.
"executionState": "A String", # Output only.
# The execution state of the ScanRun.
"urlsTestedCount": "A String", # Output only.
# 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.
"progressPercent": 42, # Output only.
# 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.
"errorTrace": { # Output only. # Output only.
# If result_state is an ERROR, this field provides the primary reason for
# scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
"mostCommonHttpErrorCode": 42, # Output only.
# If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
"code": "A String", # Output only.
# Indicates the error reason code.
"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
# If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
"code": "A String", # Output only.
# Indicates the reason code for a configuration failure.
"fieldName": "A String", # Output only.
# Indicates the full name of the ScanConfig field that triggers this error,
# for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
},
},
"resultState": "A String", # Output only.
# The result state of the ScanRun. This field is only available after the
# execution state reaches "FINISHED".
"startTime": "A String", # Output only.
# The time at which the ScanRun started.
"endTime": "A String", # Output only.
# The time at which the ScanRun reached termination state - that the ScanRun
# is either finished or stopped by user.
"hasVulnerabilities": True or False, # Output only.
# Whether the scan run has found any vulnerabilities.
"urlsCrawledCount": "A String", # Output only.
# 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.
},
],
}
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.
stop(name, body=None, x__xgafv=None)
Stops a ScanRun. The stopped ScanRun is returned.
Args:
name: string, Required.
The resource name of the ScanRun to be stopped. The name follows the
format of
'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
body: object, The request body.
The object takes the form of:
{ # Request for the `StopScanRun` 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.
# Next id: 12
"warningTraces": [ # Output only.
# A list of warnings, if such are encountered during this scan run.
{ # Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
# with useful information that helps make the scanning process more effective.
"code": "A String", # Output only.
# Indicates the warning code.
},
],
"name": "A String", # Output only.
# 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.
"executionState": "A String", # Output only.
# The execution state of the ScanRun.
"urlsTestedCount": "A String", # Output only.
# 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.
"progressPercent": 42, # Output only.
# 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.
"errorTrace": { # Output only. # Output only.
# If result_state is an ERROR, this field provides the primary reason for
# scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
"mostCommonHttpErrorCode": 42, # Output only.
# If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
"code": "A String", # Output only.
# Indicates the error reason code.
"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
# If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
"code": "A String", # Output only.
# Indicates the reason code for a configuration failure.
"fieldName": "A String", # Output only.
# Indicates the full name of the ScanConfig field that triggers this error,
# for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
},
},
"resultState": "A String", # Output only.
# The result state of the ScanRun. This field is only available after the
# execution state reaches "FINISHED".
"startTime": "A String", # Output only.
# The time at which the ScanRun started.
"endTime": "A String", # Output only.
# The time at which the ScanRun reached termination state - that the ScanRun
# is either finished or stopped by user.
"hasVulnerabilities": True or False, # Output only.
# Whether the scan run has found any vulnerabilities.
"urlsCrawledCount": "A String", # Output only.
# 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.
}