Skip to main content
No description provided.

Messages

Data models used across requests/responses.

AssetsTimeRange

No description provided.

EvaluateRulesAnnotationOptions

No description provided.
FieldTypeLabelDescription
tagssift.common.type.v1.NamedResources

EvaluateRulesFromCurrentRuleVersions

No description provided.
FieldTypeLabelDescription
rulessift.common.type.v1.ResourceIdentifiers

EvaluateRulesFromReportTemplate

No description provided.
FieldTypeLabelDescription
report_templatesift.common.type.v1.ResourceIdentifier

EvaluateRulesFromRuleConfigs

No description provided.
FieldTypeLabelDescription
configssift.rules.v1.UpdateRuleRequestrepeated

EvaluateRulesFromRuleVersions

No description provided.
FieldTypeLabelDescription
rule_version_idsstringrepeated

EvaluateRulesPreviewRequest

No description provided.
FieldTypeLabelDescription
oneof time. runsift.common.type.v1.ResourceIdentifier
oneof time. run_time_rangeRunTimeRange
oneof mode. rulesEvaluateRulesFromCurrentRuleVersions
oneof mode. rule_versionsEvaluateRulesFromRuleVersions
oneof mode. report_templateEvaluateRulesFromReportTemplate
oneof mode. rule_configsEvaluateRulesFromRuleConfigs
organization_idstringOnly required if your user belongs to multiple organizations

EvaluateRulesPreviewResponse

No description provided.
FieldTypeLabelDescription
created_annotation_countint32
dry_run_annotationssift.rules.v1.DryRunAnnotationrepeated

EvaluateRulesRequest

No description provided.
FieldTypeLabelDescription
oneof time. runsift.common.type.v1.ResourceIdentifier
oneof time. assetsAssetsTimeRange
oneof time. run_time_rangeRunTimeRange
oneof mode. rulesEvaluateRulesFromCurrentRuleVersions
oneof mode. rule_versionsEvaluateRulesFromRuleVersions
oneof mode. report_templateEvaluateRulesFromReportTemplate
oneof mode. all_applicable_rulesbool
annotation_optionsEvaluateRulesAnnotationOptions
organization_idstringOnly required if your user belongs to multiple organizations
report_namestringoptionalIf this request creates a report, this field will be used as the report name.

EvaluateRulesResponse

No description provided.
FieldTypeLabelDescription
created_annotation_countint32
report_idstringoptionalA report will be generated if rules were evaluated against a run.
job_idstringoptionalThis will be set if the job has an extended run time and is being processed asynchronously.

RunTimeRange

No description provided.
FieldTypeLabelDescription
runsift.common.type.v1.ResourceIdentifier
start_timegoogle.protobuf.Timestampoptional
end_timegoogle.protobuf.Timestampoptional

Enums

Allowed constant values used in message fields.

Services

RPC methods exposed by this API.

RuleEvaluationService

No description provided.
MethodRequestResponseDescription
EvaluateRulesEvaluateRulesRequestEvaluateRulesResponseEvaluate 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.
EvaluateRulesPreviewEvaluateRulesPreviewRequestEvaluateRulesPreviewResponsePerform a dry run evaluation for existing rules or rule configurations against a run and return the annotations that would be generated.