Package com.azure.analytics.purview.scanning

Class TriggersClient

java.lang.Object

com.azure.analytics.purview.scanning.TriggersClient

public final class TriggersClient
extends Object

Initializes a new instance of the synchronous PurviewScanningClient type.

Method Summary

Modifier and Type	Method	Description
Response<BinaryData>	createTriggerWithResponse(String dataSourceName, String scanName, BinaryData body, RequestOptions requestOptions)	Creates an instance of a trigger.
Response<BinaryData>	deleteTriggerWithResponse(String dataSourceName, String scanName, RequestOptions requestOptions)	Deletes the trigger associated with the scan.
Response<BinaryData>	getTriggerWithResponse(String dataSourceName, String scanName, RequestOptions requestOptions)	Gets trigger information.

Methods inherited from class java.lang.Object

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

Method Details

getTriggerWithResponse

public Response<BinaryData> getTriggerWithResponse(String dataSourceName,
 String scanName,
 RequestOptions requestOptions)

Gets trigger information.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     id: String
     name: String
     properties: {
         recurrence: {
             frequency: String(Week/Month)
             interval: Integer
             startTime: String
             endTime: String
             schedule: {
                 additionalProperties: {
                     String: Object
                 }
                 minutes: [
                     int
                 ]
                 hours: [
                     int
                 ]
                 weekDays: [
                     String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                 ]
                 monthDays: [
                     int
                 ]
                 monthlyOccurrences: [
                     {
                         additionalProperties: {
                             String: Object
                         }
                         day: String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                         occurrence: Integer
                     }
                 ]
             }
             timeZone: String
         }
         recurrenceInterval: String
         createdAt: String
         lastModifiedAt: String
         lastScheduled: String
         scanLevel: String(Full/Incremental)
         incrementalScanStartTime: String
     }
 }
 

Parameters:

dataSourceName - The dataSourceName parameter.

scanName - The scanName parameter.

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

Returns:

trigger information along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

createTriggerWithResponse

public Response<BinaryData> createTriggerWithResponse(String dataSourceName,
 String scanName,
 BinaryData body,
 RequestOptions requestOptions)

Creates an instance of a trigger.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Request Body Schema

 {
     id: String
     name: String
     properties: {
         recurrence: {
             frequency: String(Week/Month)
             interval: Integer
             startTime: String
             endTime: String
             schedule: {
                 additionalProperties: {
                     String: Object
                 }
                 minutes: [
                     int
                 ]
                 hours: [
                     int
                 ]
                 weekDays: [
                     String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                 ]
                 monthDays: [
                     int
                 ]
                 monthlyOccurrences: [
                     {
                         additionalProperties: {
                             String: Object
                         }
                         day: String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                         occurrence: Integer
                     }
                 ]
             }
             timeZone: String
         }
         recurrenceInterval: String
         createdAt: String
         lastModifiedAt: String
         lastScheduled: String
         scanLevel: String(Full/Incremental)
         incrementalScanStartTime: String
     }
 }
 

Response Body Schema

 {
     id: String
     name: String
     properties: {
         recurrence: {
             frequency: String(Week/Month)
             interval: Integer
             startTime: String
             endTime: String
             schedule: {
                 additionalProperties: {
                     String: Object
                 }
                 minutes: [
                     int
                 ]
                 hours: [
                     int
                 ]
                 weekDays: [
                     String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                 ]
                 monthDays: [
                     int
                 ]
                 monthlyOccurrences: [
                     {
                         additionalProperties: {
                             String: Object
                         }
                         day: String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                         occurrence: Integer
                     }
                 ]
             }
             timeZone: String
         }
         recurrenceInterval: String
         createdAt: String
         lastModifiedAt: String
         lastScheduled: String
         scanLevel: String(Full/Incremental)
         incrementalScanStartTime: String
     }
 }
 

Parameters:

dataSourceName - The dataSourceName parameter.

scanName - The scanName parameter.

body - The body parameter.

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

Returns:

the response body along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

deleteTriggerWithResponse

public Response<BinaryData> deleteTriggerWithResponse(String dataSourceName,
 String scanName,
 RequestOptions requestOptions)

Deletes the trigger associated with the scan.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     id: String
     name: String
     properties: {
         recurrence: {
             frequency: String(Week/Month)
             interval: Integer
             startTime: String
             endTime: String
             schedule: {
                 additionalProperties: {
                     String: Object
                 }
                 minutes: [
                     int
                 ]
                 hours: [
                     int
                 ]
                 weekDays: [
                     String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                 ]
                 monthDays: [
                     int
                 ]
                 monthlyOccurrences: [
                     {
                         additionalProperties: {
                             String: Object
                         }
                         day: String(Sunday/Monday/Tuesday/Wednesday/Thursday/Friday/Saturday)
                         occurrence: Integer
                     }
                 ]
             }
             timeZone: String
         }
         recurrenceInterval: String
         createdAt: String
         lastModifiedAt: String
         lastScheduled: String
         scanLevel: String(Full/Incremental)
         incrementalScanStartTime: String
     }
 }
 

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 body along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.