public final class ScanResultBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
DynamicRequest |
cancelScan(String dataSourceName,
String scanName,
String runId)
Cancels a scan.
|
DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
DynamicRequest |
listScanHistory(String dataSourceName,
String scanName)
Lists the scan history of a scan.
|
DynamicRequest |
listScanHistoryNext(String nextLink)
Get the next page of items.
|
DynamicRequest |
runScan(String dataSourceName,
String scanName,
String runId)
Runs the scan.
|
public DynamicRequest runScan(String dataSourceName, String scanName, String runId)
Optional Query Parameters
Name | Type | Description |
---|---|---|
scanLevel | ScanLevelType | The scanLevel parameter |
Response Body Schema
{
scanResultId: UUID
startTime: OffsetDateTime
endTime: OffsetDateTime
status: String(Accepted/InProgress/TransientFailure/Succeeded/Failed/Canceled)
error: {
code: String
message: String
target: String
details: [
{
code: String
message: String
target: String
details: [
(recursive schema, see above)
]
}
]
}
}
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.runId
- The runId parameter.public DynamicRequest cancelScan(String dataSourceName, String scanName, String runId)
Response Body Schema
{
scanResultId: UUID
startTime: OffsetDateTime
endTime: OffsetDateTime
status: String(Accepted/InProgress/TransientFailure/Succeeded/Failed/Canceled)
error: {
code: String
message: String
target: String
details: [
{
code: String
message: String
target: String
details: [
(recursive schema, see above)
]
}
]
}
}
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.runId
- The runId parameter.public DynamicRequest listScanHistory(String dataSourceName, String scanName)
Response Body Schema
{
value: [
{
parentId: String
id: String
resourceId: String
status: String
assetsDiscovered: Long
assetsClassified: Long
diagnostics: {
notifications: [
{
message: String
code: Integer
}
]
exceptionCountMap: {
String: int
}
}
startTime: OffsetDateTime
queuedTime: OffsetDateTime
pipelineStartTime: OffsetDateTime
endTime: OffsetDateTime
scanRulesetVersion: Integer
scanRulesetType: String(Custom/System)
scanLevelType: String(Full/Incremental)
errorMessage: String
error: {
code: String
message: String
target: String
details: [
{
code: String
message: String
target: String
details: [
(recursive schema, see above)
]
}
]
}
runType: String
dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI)
}
]
nextLink: String
count: Long
}
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.public DynamicRequest listScanHistoryNext(String nextLink)
Response Body Schema
{
value: [
{
parentId: String
id: String
resourceId: String
status: String
assetsDiscovered: Long
assetsClassified: Long
diagnostics: {
notifications: [
{
message: String
code: Integer
}
]
exceptionCountMap: {
String: int
}
}
startTime: OffsetDateTime
queuedTime: OffsetDateTime
pipelineStartTime: OffsetDateTime
endTime: OffsetDateTime
scanRulesetVersion: Integer
scanRulesetType: String(Custom/System)
scanLevelType: String(Full/Incremental)
errorMessage: String
error: {
code: String
message: String
target: String
details: [
{
code: String
message: String
target: String
details: [
(recursive schema, see above)
]
}
]
}
runType: String
dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI)
}
]
nextLink: String
count: Long
}
nextLink
- The nextLink parameter.public DynamicRequest invoke()
Copyright © 2021. All rights reserved.