Reference documentation and code samples for the Google Cloud Security Command Center V1p1beta1 Client class Finding.
Security Command Center finding.
A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
Generated from protobuf message google.cloud.securitycenter.v1p1beta1.Finding
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" |
↳ parent |
string
The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" |
↳ resource_name |
string
For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. |
↳ state |
int
The state of the finding. |
↳ category |
string
The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" |
↳ external_uri |
string
The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. |
↳ source_properties |
array|Google\Protobuf\Internal\MapField
Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. |
↳ security_marks |
Google\Cloud\SecurityCenter\V1p1beta1\SecurityMarks
Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. |
↳ event_time |
Google\Protobuf\Timestamp
The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp. |
↳ create_time |
Google\Protobuf\Timestamp
The time at which the finding was created in Security Command Center. |
↳ severity |
int
The severity of the finding. This field is managed by the source that writes the finding. |
↳ canonical_name |
string
The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. |
getName
The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}"
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}"
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParent
The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time.
For example: "organizations/{organization_id}/sources/{source_id}"
Generated from protobuf field string parent = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time.
For example: "organizations/{organization_id}/sources/{source_id}"
Generated from protobuf field string parent = 2;
| 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. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
Generated from protobuf field string resource_name = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setResourceName
For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
Generated from protobuf field string resource_name = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The state of the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The state of the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategory
The additional taxonomy group within findings from a given source.
This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
Generated from protobuf field string category = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
setCategory
The additional taxonomy group within findings from a given source.
This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
Generated from protobuf field string category = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExternalUri
The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found.
This field is guaranteed to be either empty or a well formed URL.
Generated from protobuf field string external_uri = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setExternalUri
The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found.
This field is guaranteed to be either empty or a well formed URL.
Generated from protobuf field string external_uri = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSourceProperties
Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
Generated from protobuf field map<string, .google.protobuf.Value> source_properties = 7;
| 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 in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
Generated from protobuf field map<string, .google.protobuf.Value> source_properties = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecurityMarks
Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.SecurityMarks security_marks = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V1p1beta1\SecurityMarks|null | |
hasSecurityMarks
clearSecurityMarks
setSecurityMarks
Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.SecurityMarks security_marks = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V1p1beta1\SecurityMarks
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEventTime
The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp.
Generated from protobuf field .google.protobuf.Timestamp event_time = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEventTime
clearEventTime
setEventTime
The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp.
Generated from protobuf field .google.protobuf.Timestamp event_time = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
The time at which the finding was created in Security Command Center.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
The time at which the finding was created in Security Command Center.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10;
| 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.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.Finding.Severity severity = 13;
| Returns | |
|---|---|
| Type | Description |
int | |
setSeverity
The severity of the finding. This field is managed by the source that writes the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.Finding.Severity severity = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCanonicalName
The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding.
Generated from protobuf field string canonical_name = 14;
| Returns | |
|---|---|
| Type | Description |
string | |
setCanonicalName
The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding.
Generated from protobuf field string canonical_name = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |