Package com.azure.analytics.purview.scanning

Class SystemScanRulesetsClient

java.lang.Object

com.azure.analytics.purview.scanning.SystemScanRulesetsClient

public final class SystemScanRulesetsClient
extends Object

Initializes a new instance of the synchronous PurviewScanningClient type.

Method Summary

Modifier and Type	Method	Description
Response<BinaryData>	getByVersionWithResponse(int version, RequestOptions requestOptions)	Get a scan ruleset by version.
Response<BinaryData>	getLatestWithResponse(RequestOptions requestOptions)	Get the latest version of a system scan ruleset.
Response<BinaryData>	getWithResponse(String dataSourceType, RequestOptions requestOptions)	Get a system scan ruleset for a data source.
PagedIterable<BinaryData>	listAll(RequestOptions requestOptions)	List all system scan rulesets for an account.
PagedIterable<BinaryData>	listVersionsByDataSource(RequestOptions requestOptions)	List system scan ruleset versions in Data catalog.

Methods inherited from class java.lang.Object

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

Method Details

listAll

public PagedIterable<BinaryData> listAll(RequestOptions requestOptions)

List all system scan rulesets for an account.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     value: [
         {
             id: String
             name: String
             scanRulesetType: String(Custom/System)
             status: String(Enabled/Disabled)
             version: Integer
         }
     ]
     nextLink: String
     count: Long
 }
 

Parameters:

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.

getWithResponse

public Response<BinaryData> getWithResponse(String dataSourceType,
 RequestOptions requestOptions)

Get a system scan ruleset for a data source.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Parameters:

dataSourceType - The dataSourceType parameter.

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

Returns:

a system scan ruleset for a data source along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

getByVersionWithResponse

public Response<BinaryData> getByVersionWithResponse(int version,
 RequestOptions requestOptions)

Get a scan ruleset by version.

Query Parameters

Query Parameters

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

Response Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Parameters:

version - The version parameter.

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

Returns:

a scan ruleset by version along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

getLatestWithResponse

public Response<BinaryData> getLatestWithResponse(RequestOptions requestOptions)

Get the latest version of a system scan ruleset.

Query Parameters

Query Parameters

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

Response Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Parameters:

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

Returns:

the latest version of a system scan ruleset along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

listVersionsByDataSource

public PagedIterable<BinaryData> listVersionsByDataSource(RequestOptions requestOptions)

List system scan ruleset versions in Data catalog.

Query Parameters

Query Parameters

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

Response Body Schema

 {
     value: [
         {
             id: String
             name: String
             scanRulesetType: String(Custom/System)
             status: String(Enabled/Disabled)
             version: Integer
         }
     ]
     nextLink: String
     count: Long
 }
 

Parameters:

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.