Package com.azure.analytics.purview.scanning

Class ScanResultAsyncClient

java.lang.Object

com.azure.analytics.purview.scanning.ScanResultAsyncClient

public final class ScanResultAsyncClient
extends Object

Initializes a new instance of the asynchronous PurviewScanningClient type.

Method Summary

Modifier and Type	Method	Description
Mono<Response<BinaryData>>	cancelScanWithResponse(String dataSourceName, String scanName, String runId, RequestOptions requestOptions)	Cancels a scan.
PagedFlux<BinaryData>	listScanHistory(String dataSourceName, String scanName, RequestOptions requestOptions)	Lists the scan history of a scan.
Mono<Response<BinaryData>>	runScanWithResponse(String dataSourceName, String scanName, String runId, RequestOptions requestOptions)	Runs the scan.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

runScanWithResponse

public Mono<Response<BinaryData>> runScanWithResponse(String dataSourceName,
 String scanName,
 String runId,
 RequestOptions requestOptions)

Runs the scan.

Query Parameters

Query Parameters

Name	Type	Required	Description
scanLevel	String	No	The scanLevel parameter
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     scanResultId: String
     startTime: String
     endTime: String
     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)
                 ]
             }
         ]
     }
 }
 

Parameters:

dataSourceName - The dataSourceName parameter.

scanName - The scanName parameter.

runId - The runId parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response on successful completion of Mono.

Throws:

HttpResponseException - thrown if the request is rejected by server.

cancelScanWithResponse

public Mono<Response<BinaryData>> cancelScanWithResponse(String dataSourceName,
 String scanName,
 String runId,
 RequestOptions requestOptions)

Cancels a scan.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     scanResultId: String
     startTime: String
     endTime: String
     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)
                 ]
             }
         ]
     }
 }
 

Parameters:

dataSourceName - The dataSourceName parameter.

scanName - The scanName parameter.

runId - The runId parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response on successful completion of Mono.

Throws:

HttpResponseException - thrown if the request is rejected by server.

listScanHistory

public PagedFlux<BinaryData> listScanHistory(String dataSourceName,
 String scanName,
 RequestOptions requestOptions)

Lists the scan history of a scan.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

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: String
             queuedTime: String
             pipelineStartTime: String
             endTime: String
             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
 }
 

Parameters:

dataSourceName - The dataSourceName parameter.

scanName - The scanName parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

HttpResponseException - thrown if the request is rejected by server.