rule_evaluation
Protocol buffer definition for rule_evaluation
sift/rule_evaluation/v1/rule_evaluation.proto
AssetsTimeRange
| Field | Type | Label | Description |
|---|---|---|---|
| assets | sift.common.type.v1.NamedResources | ||
| start_time | google.protobuf.Timestamp | ||
| end_time | google.protobuf.Timestamp |
EvaluateRulesAnnotationOptions
| Field | Type | Label | Description |
|---|---|---|---|
| tags | sift.common.type.v1.NamedResources |
EvaluateRulesFromCurrentRuleVersions
| Field | Type | Label | Description |
|---|---|---|---|
| rules | sift.common.type.v1.ResourceIdentifiers |
EvaluateRulesFromReportTemplate
| Field | Type | Label | Description |
|---|---|---|---|
| report_template | sift.common.type.v1.ResourceIdentifier |
EvaluateRulesFromRuleConfigs
| Field | Type | Label | Description |
|---|---|---|---|
| configs | sift.rules.v1.UpdateRuleRequest | repeated |
EvaluateRulesFromRuleVersions
| Field | Type | Label | Description |
|---|---|---|---|
| rule_version_ids | string | repeated |
EvaluateRulesPreviewRequest
| Field | Type | Label | Description |
|---|---|---|---|
| run | sift.common.type.v1.ResourceIdentifier | ||
| rules | EvaluateRulesFromCurrentRuleVersions | ||
| rule_versions | EvaluateRulesFromRuleVersions | ||
| report_template | EvaluateRulesFromReportTemplate | ||
| rule_configs | EvaluateRulesFromRuleConfigs | ||
| organization_id | string | Only required if your user belongs to multiple organizations |
EvaluateRulesPreviewResponse
| Field | Type | Label | Description |
|---|---|---|---|
| created_annotation_count | int32 | ||
| dry_run_annotations | sift.rules.v1.DryRunAnnotation | repeated |
EvaluateRulesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| run | sift.common.type.v1.ResourceIdentifier | ||
| assets | AssetsTimeRange | ||
| rules | EvaluateRulesFromCurrentRuleVersions | ||
| rule_versions | EvaluateRulesFromRuleVersions | ||
| report_template | EvaluateRulesFromReportTemplate | ||
| annotation_options | EvaluateRulesAnnotationOptions | ||
| organization_id | string | Only required if your user belongs to multiple organizations | |
| report_name | string | optional | If this request creates a report, this field will be used as the report name. |
EvaluateRulesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| created_annotation_count | int32 | ||
| report_id | string | optional | A report will be generated if rules were evaluated against a run. |
| job_id | string | optional | This will be set if the job has an extended run time and is being processed asynchronously. |
RuleEvaluationService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| EvaluateRules | EvaluateRulesRequest | EvaluateRulesResponse | Evaluate rules from a designated source against a run or asset and return the total amount of annotations created and the ID of the generated report. |
| EvaluateRulesPreview | EvaluateRulesPreviewRequest | EvaluateRulesPreviewResponse | Perform a dry run evaluation for existing rules or rule configurations against a run and return the annotations that would be generated. |