Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

PolicyRule class


PolicyRule represents a self contained regulation that will be applied to a set of sensor metrics. The PolicyRule in its simplest form will have a trigger and an action. Rule evaluation will look at the trigger condition for breaches and invoke the action if required. PolicyRule has precedence and can be enabled or disabled.

PolicyRule class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the PolicyRule class.

Basic APIs

Name

HTTP
method

URI

Description

create

POST

Creates a PolicyRule object.

delete

DELETE

Deletes a PolicyRule object.

modify

PUT

Modifies a PolicyRule object.

search

POST

Searches for PolicyRule objects.

Operation APIs

Name

HTTP
method

URI

Description

evaluate

POST

 

Relationship APIs

The PolicyRule class has no relationship APIs.

PolicyRule class relationships and attributes

The following tables list the relationships and attributes of the PolicyRule class.

Relationships

Name

Type

Multi-
plicity

Description

policyRuleGroup

1

 

resourceRule

1

 

cloudClass

1

Fully-qualified name of the class to which the object belongs

provider

1

Provider that created the object

tags

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

isEnabled
Boolean

1

 

precedence
Integer

1

 

description
String

0..1

Text that describes the object

guid
String

1

Globally unique identifier for the object

labels
String

0..*

 

modifiedDate

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*