Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class SimulatedFinding.
The minimum set of fields needed to represent a simulated finding from a Security Health Analytics custom module.
Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulatedFinding
Namespace
Google \ Cloud \ SecurityCenterManagement \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The relative resource name of the finding, in one of the following formats: * |
↳ parent |
string
The relative resource name of the source the finding belongs to. For example, |
↳ resource_name |
string
For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. When the finding is for a non-Google Cloud resource, the value can be a customer or partner defined string. This field is immutable after creation time. |
↳ category |
string
The additional taxonomy group within findings from a given source. For example, |
↳ state |
int
Output only. The state of the finding. |
↳ source_properties |
array|Google\Protobuf\Internal\MapField
Source-specific properties. These properties are managed by the source that writes the finding. The key names must be between 1 and 255 characters; they must start with a letter and contain alphanumeric characters or underscores only. |
↳ event_time |
Google\Protobuf\Timestamp
The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. If the finding is later resolved, then this time reflects when the finding was resolved. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. The event time must not be set to a value greater than the current timestamp. |
↳ severity |
int
The severity of the finding. This field is managed by the source that writes the finding. |
↳ finding_class |
int
The class of the finding. |
getName
Identifier. The relative resource name of the finding, in one of the following formats:
organizations/{organization_id}/sources/{source_id}/findings/{finding_id}folders/{folder_id}/sources/{source_id}/findings/{finding_id}projects/{project_id}/sources/{source_id}/findings/{finding_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The relative resource name of the finding, in one of the following formats:
organizations/{organization_id}/sources/{source_id}/findings/{finding_id}folders/{folder_id}/sources/{source_id}/findings/{finding_id}projects/{project_id}/sources/{source_id}/findings/{finding_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParent
The relative resource name of the source the
finding belongs to. For example,
organizations/{organization_id}/sources/{source_id}. This field is
immutable after creation time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
The relative resource name of the source the
finding belongs to. For example,
organizations/{organization_id}/sources/{source_id}. This field is
immutable after creation time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceName
For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. When the finding is for a non-Google Cloud resource, the value can be a customer or partner defined string. This field is immutable after creation time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setResourceName
For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. When the finding is for a non-Google Cloud resource, the value can be a customer or partner defined string. This field is immutable after creation time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCategory
The additional taxonomy group within findings from a given source. For
example, XSS_FLASH_INJECTION. This field is immutable after creation
time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCategory
The additional taxonomy group within findings from a given source. For
example, XSS_FLASH_INJECTION. This field is immutable after creation
time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the finding.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The state of the finding.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceProperties
Source-specific properties. These properties are managed by the source that writes the finding. The key names must be between 1 and 255 characters; they must start with a letter and contain alphanumeric characters or underscores only.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setSourceProperties
Source-specific properties. These properties are managed by the source that writes the finding. The key names must be between 1 and 255 characters; they must start with a letter and contain alphanumeric characters or underscores only.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventTime
The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. If the finding is later resolved, then this time reflects when the finding was resolved.
For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. The event time must not be set to a value greater than the current timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEventTime
clearEventTime
setEventTime
The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. If the finding is later resolved, then this time reflects when the finding was resolved.
For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. The event time must not be set to a value greater than the current timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSeverity
The severity of the finding. This field is managed by the source that writes the finding.
| Returns | |
|---|---|
| Type | Description |
int |
|
setSeverity
The severity of the finding. This field is managed by the source that writes the finding.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFindingClass
The class of the finding.
| Returns | |
|---|---|
| Type | Description |
int |
|
setFindingClass
The class of the finding.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|