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.
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;
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;
var
string
$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;
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;
var
string
$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;
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;
var
string
$this
getState
The state of the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;
int
setState
The state of the finding.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;
var
int
$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;
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;
var
string
$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;
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;
var
string
$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;
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;
var
array|Google\Protobuf\Internal\MapField
$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];
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];
$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;
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;
var
Google\Protobuf\Timestamp
$this
getCreateTime
The time at which the finding was created in Security Command Center.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10;
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;
var
Google\Protobuf\Timestamp
$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;
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;
var
int
$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;
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;
var
string
$this
