Reference documentation and code samples for the Google Cloud Chronicle V1 Client class FindingsRefinement.
Represents a set of logic conditions used to refine various types of findings such as curated rule detections.
Generated from protobuf message google.cloud.chronicle.v1.FindingsRefinement
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Full resource name for the findings refinement. Format: projects/{project}/locations/{region}/instances/{instance}/findingsRefinements/{findings_refinement} |
↳ display_name |
string
Display name of the findings refinement. |
↳ type |
int
The type of findings refinement. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp of when the findings refinement was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp of when the findings refinement was last updated. |
↳ query |
string
The query for the findings refinement. Works in conjunction with the type field to determine the findings refinement behavior. The syntax of this query is the same as a UDM search string. See the following for more information: https://cloud.google.com/chronicle/docs/investigation/udm-search |
↳ outcome_filters |
array<OutcomeFilter>
Optional. The outcome filters for the findings refinement. These allow you to specify filters that are applied to the outcome variables in the detection. All filters must be true for a detection to match the findings refinement. |
getName
Full resource name for the findings refinement.
Format: projects/{project}/locations/{region}/instances/{instance}/findingsRefinements/{findings_refinement}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Full resource name for the findings refinement.
Format: projects/{project}/locations/{region}/instances/{instance}/findingsRefinements/{findings_refinement}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Display name of the findings refinement.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Display name of the findings refinement.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
The type of findings refinement.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type FindingsRefinementType. |
setType
The type of findings refinement.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type FindingsRefinementType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp of when the findings refinement was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of when the findings refinement was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp of when the findings refinement was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp of when the findings refinement was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
The query for the findings refinement. Works in conjunction with the type field to determine the findings refinement behavior. The syntax of this query is the same as a UDM search string. See the following for more information: https://cloud.google.com/chronicle/docs/investigation/udm-search
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
The query for the findings refinement. Works in conjunction with the type field to determine the findings refinement behavior. The syntax of this query is the same as a UDM search string. See the following for more information: https://cloud.google.com/chronicle/docs/investigation/udm-search
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutcomeFilters
Optional. The outcome filters for the findings refinement. These allow you to specify filters that are applied to the outcome variables in the detection. All filters must be true for a detection to match the findings refinement.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<OutcomeFilter> |
|
setOutcomeFilters
Optional. The outcome filters for the findings refinement. These allow you to specify filters that are applied to the outcome variables in the detection. All filters must be true for a detection to match the findings refinement.
| Parameter | |
|---|---|
| Name | Description |
var |
array<OutcomeFilter>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|