Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DetectionExclusionDetectorActivity.
The activity for a findings refinement that is a detection exclusion broken down for one specific detector.
Generated from protobuf message google.cloud.chronicle.v1.DetectionExclusionActivity.DetectionExclusionDetectorActivity
Namespace
Google \ Cloud \ Chronicle \ V1 \ DetectionExclusionActivityMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ curated_rule |
string
Full resource name for the curated rule this activity corresponds to. Format: projects/{project}/locations/{location}/instances/{instance}/curatedRules/{rule} |
↳ curated_rule_set |
string
Full resource name for the curated rule set this activity corresponds to. This field will only be set if the customer has access to the curated rule set the exclusion is applied to. Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curated_rule_set_category}/curatedRuleSets/{curated_rule_set} |
↳ rule |
string
Full resource name for the rule this activity corresponds to. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule} |
↳ deleted_curated_rule_set |
string
Full resource name for the deleted curated rule set this activity corresponds to. This field will only be set if the customer does not have access to the curated rule set the exclusion is applied to. Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curated_rule_set_category}/curatedRuleSets/{curated_rule_set} |
↳ excluded_detection_count |
int|string
The number of detections for the detector that were excluded by the detection exclusion. |
↳ total_detection_count |
int|string
The total number of detections found by the detector. This includes both excluded detections and non-excluded detections. |
getCuratedRule
Full resource name for the curated rule this activity corresponds to.
Format: projects/{project}/locations/{location}/instances/{instance}/curatedRules/{rule}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCuratedRule
setCuratedRule
Full resource name for the curated rule this activity corresponds to.
Format: projects/{project}/locations/{location}/instances/{instance}/curatedRules/{rule}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCuratedRuleSet
Full resource name for the curated rule set this activity corresponds to. This field will only be set if the customer has access to the curated rule set the exclusion is applied to.
Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curated_rule_set_category}/curatedRuleSets/{curated_rule_set}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCuratedRuleSet
setCuratedRuleSet
Full resource name for the curated rule set this activity corresponds to. This field will only be set if the customer has access to the curated rule set the exclusion is applied to.
Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curated_rule_set_category}/curatedRuleSets/{curated_rule_set}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRule
Full resource name for the rule this activity corresponds to.
Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasRule
setRule
Full resource name for the rule this activity corresponds to.
Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeletedCuratedRuleSet
Full resource name for the deleted curated rule set this activity corresponds to. This field will only be set if the customer does not have access to the curated rule set the exclusion is applied to.
Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curated_rule_set_category}/curatedRuleSets/{curated_rule_set}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDeletedCuratedRuleSet
setDeletedCuratedRuleSet
Full resource name for the deleted curated rule set this activity corresponds to. This field will only be set if the customer does not have access to the curated rule set the exclusion is applied to.
Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curated_rule_set_category}/curatedRuleSets/{curated_rule_set}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExcludedDetectionCount
The number of detections for the detector that were excluded by the detection exclusion.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setExcludedDetectionCount
The number of detections for the detector that were excluded by the detection exclusion.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTotalDetectionCount
The total number of detections found by the detector. This includes both excluded detections and non-excluded detections.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTotalDetectionCount
The total number of detections found by the detector. This includes both excluded detections and non-excluded detections.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetectorName
| Returns | |
|---|---|
| Type | Description |
string |
|