Google Cloud Security Command Center V1p1beta1 Client - Class Finding (1.31.0)

Version 1.31.0

• 2.0.1 (latest)
• 2.0.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.2
• 1.21.0
• 1.20.2
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.1
• 1.14.2
• 1.13.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Namespace

Google \ Cloud \ SecurityCenter \ V1p1beta1

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}"

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}"

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}"

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}"

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.

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

The state of the finding.

Returns
Type	Description
int

setState

The state of the finding.

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"

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"

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.

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.

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.

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.

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.

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.

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.

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.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getCreateTime

The time at which the finding was created in Security Command Center.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time at which the finding was created in Security Command Center.

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

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.

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this