TriggersOperations Class

TriggersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

TriggersOperations

Constructor

TriggersOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Methods

create_trigger	Creates an instance of a trigger.
delete_trigger	Deletes the trigger associated with the scan.
get_trigger	Gets trigger information.

create_trigger

Creates an instance of a trigger.

create_trigger(data_source_name: str, scan_name: str, body: Any, **kwargs: Any) -> Any

Parameters

data_source_name

str

Required

scan_name

str

Required

body

<xref:Any>

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # JSON input template you can fill out and use as your body input.
   body = {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "properties": {
           "createdAt": "2020-02-20 00:00:00",  # Optional.
           "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
           "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
           "lastScheduled": "2020-02-20 00:00:00",  # Optional.
           "recurrence": {
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "frequency": "str",  # Optional. Possible values include: "Week", "Month".
               "interval": 0,  # Optional.
               "schedule": {
                   "hours": [
                       0  # Optional.
                   ],
                   "minutes": [
                       0  # Optional.
                   ],
                   "monthDays": [
                       0  # Optional.
                   ],
                   "monthlyOccurrences": [
                       {
                           "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                           "occurrence": 0  # Optional.
                       }
                   ],
                   "weekDays": [
                       "str"  # Optional.
                   ]
               },
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "timeZone": "str"  # Optional.
           },
           "recurrenceInterval": "str",  # Optional.
           "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
       }
   }

   # response body for status code(s): 200, 201
   response.json() == {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "properties": {
           "createdAt": "2020-02-20 00:00:00",  # Optional.
           "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
           "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
           "lastScheduled": "2020-02-20 00:00:00",  # Optional.
           "recurrence": {
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "frequency": "str",  # Optional. Possible values include: "Week", "Month".
               "interval": 0,  # Optional.
               "schedule": {
                   "hours": [
                       0  # Optional.
                   ],
                   "minutes": [
                       0  # Optional.
                   ],
                   "monthDays": [
                       0  # Optional.
                   ],
                   "monthlyOccurrences": [
                       {
                           "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                           "occurrence": 0  # Optional.
                       }
                   ],
                   "weekDays": [
                       "str"  # Optional.
                   ]
               },
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "timeZone": "str"  # Optional.
           },
           "recurrenceInterval": "str",  # Optional.
           "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
       }
   }

delete_trigger

Deletes the trigger associated with the scan.

delete_trigger(data_source_name: str, scan_name: str, **kwargs: Any) -> Optional[Any]

Parameters

data_source_name

str

Required

scan_name

str

Required

Returns

JSON object

Return type

<xref:Any>,

None

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "properties": {
           "createdAt": "2020-02-20 00:00:00",  # Optional.
           "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
           "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
           "lastScheduled": "2020-02-20 00:00:00",  # Optional.
           "recurrence": {
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "frequency": "str",  # Optional. Possible values include: "Week", "Month".
               "interval": 0,  # Optional.
               "schedule": {
                   "hours": [
                       0  # Optional.
                   ],
                   "minutes": [
                       0  # Optional.
                   ],
                   "monthDays": [
                       0  # Optional.
                   ],
                   "monthlyOccurrences": [
                       {
                           "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                           "occurrence": 0  # Optional.
                       }
                   ],
                   "weekDays": [
                       "str"  # Optional.
                   ]
               },
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "timeZone": "str"  # Optional.
           },
           "recurrenceInterval": "str",  # Optional.
           "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
       }
   }

get_trigger

Gets trigger information.

get_trigger(data_source_name: str, scan_name: str, **kwargs: Any) -> Any

Parameters

data_source_name

str

Required

scan_name

str

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "properties": {
           "createdAt": "2020-02-20 00:00:00",  # Optional.
           "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
           "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
           "lastScheduled": "2020-02-20 00:00:00",  # Optional.
           "recurrence": {
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "frequency": "str",  # Optional. Possible values include: "Week", "Month".
               "interval": 0,  # Optional.
               "schedule": {
                   "hours": [
                       0  # Optional.
                   ],
                   "minutes": [
                       0  # Optional.
                   ],
                   "monthDays": [
                       0  # Optional.
                   ],
                   "monthlyOccurrences": [
                       {
                           "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                           "occurrence": 0  # Optional.
                       }
                   ],
                   "weekDays": [
                       "str"  # Optional.
                   ]
               },
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "timeZone": "str"  # Optional.
           },
           "recurrenceInterval": "str",  # Optional.
           "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
       }
   }