public final class ScansBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
DynamicRequest |
createOrUpdate(String dataSourceName,
String scanName)
Creates an instance of a scan.
|
DynamicRequest |
delete(String dataSourceName,
String scanName)
Deletes the scan associated with the data source.
|
DynamicRequest |
get(String dataSourceName,
String scanName)
Gets a scan information.
|
DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
DynamicRequest |
listByDataSource(String dataSourceName)
List scans in data source.
|
DynamicRequest |
listByDataSourceNext(String nextLink)
Get the next page of items.
|
public DynamicRequest createOrUpdate(String dataSourceName, String scanName)
Request Body Schema
{
id: String
name: String
scanResults: [
{
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)
}
]
}
Response Body Schema
(recursive schema, see above)
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.public DynamicRequest get(String dataSourceName, String scanName)
Response Body Schema
{
id: String
name: String
scanResults: [
{
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)
}
]
}
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.public DynamicRequest delete(String dataSourceName, String scanName)
Response Body Schema
{
id: String
name: String
scanResults: [
{
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)
}
]
}
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.public DynamicRequest listByDataSource(String dataSourceName)
Response Body Schema
{
value: [
{
id: String
name: String
scanResults: [
{
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.public DynamicRequest listByDataSourceNext(String nextLink)
Response Body Schema
{
value: [
{
id: String
name: String
scanResults: [
{
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.