Interface FindingOrBuilder (2.28.0)

public interface FindingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsSourceProperties(String key)

public abstract boolean containsSourceProperties(String key)

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.

map<string, .google.protobuf.Value> source_properties = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCanonicalName()

public abstract String 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.

string canonical_name = 14;

Returns
TypeDescription
String

The canonicalName.

getCanonicalNameBytes()

public abstract ByteString getCanonicalNameBytes()

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.

string canonical_name = 14;

Returns
TypeDescription
ByteString

The bytes for canonicalName.

getCategory()

public abstract String getCategory()

The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"

string category = 5;

Returns
TypeDescription
String

The category.

getCategoryBytes()

public abstract ByteString getCategoryBytes()

The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"

string category = 5;

Returns
TypeDescription
ByteString

The bytes for category.

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 10;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 10;

Returns
TypeDescription
TimestampOrBuilder

getEventTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp event_time = 9;

Returns
TypeDescription
Timestamp

The eventTime.

getEventTimeOrBuilder()

public abstract TimestampOrBuilder getEventTimeOrBuilder()

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.

.google.protobuf.Timestamp event_time = 9;

Returns
TypeDescription
TimestampOrBuilder

getExternalUri()

public abstract String 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.

string external_uri = 6;

Returns
TypeDescription
String

The externalUri.

getExternalUriBytes()

public abstract ByteString getExternalUriBytes()

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.

string external_uri = 6;

Returns
TypeDescription
ByteString

The bytes for externalUri.

getName()

public abstract String 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}"

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParent()

public abstract String 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}"

string parent = 2;

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 2;

Returns
TypeDescription
ByteString

The bytes for parent.

getResourceName()

public abstract String 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.

string resource_name = 3;

Returns
TypeDescription
String

The resourceName.

getResourceNameBytes()

public abstract ByteString getResourceNameBytes()

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.

string resource_name = 3;

Returns
TypeDescription
ByteString

The bytes for resourceName.

getSecurityMarks()

public abstract SecurityMarks 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.

.google.cloud.securitycenter.v1p1beta1.SecurityMarks security_marks = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SecurityMarks

The securityMarks.

getSecurityMarksOrBuilder()

public abstract SecurityMarksOrBuilder getSecurityMarksOrBuilder()

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.

.google.cloud.securitycenter.v1p1beta1.SecurityMarks security_marks = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SecurityMarksOrBuilder

getSeverity()

public abstract Finding.Severity getSeverity()

The severity of the finding. This field is managed by the source that writes the finding.

.google.cloud.securitycenter.v1p1beta1.Finding.Severity severity = 13;

Returns
TypeDescription
Finding.Severity

The severity.

getSeverityValue()

public abstract int getSeverityValue()

The severity of the finding. This field is managed by the source that writes the finding.

.google.cloud.securitycenter.v1p1beta1.Finding.Severity severity = 13;

Returns
TypeDescription
int

The enum numeric value on the wire for severity.

getSourceProperties()

public abstract Map<String,Value> getSourceProperties()
Returns
TypeDescription
Map<String,Value>

getSourcePropertiesCount()

public abstract int getSourcePropertiesCount()

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.

map<string, .google.protobuf.Value> source_properties = 7;

Returns
TypeDescription
int

getSourcePropertiesMap()

public abstract Map<String,Value> getSourcePropertiesMap()

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.

map<string, .google.protobuf.Value> source_properties = 7;

Returns
TypeDescription
Map<String,Value>

getSourcePropertiesOrDefault(String key, Value defaultValue)

public abstract Value getSourcePropertiesOrDefault(String key, Value defaultValue)

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.

map<string, .google.protobuf.Value> source_properties = 7;

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getSourcePropertiesOrThrow(String key)

public abstract Value getSourcePropertiesOrThrow(String key)

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.

map<string, .google.protobuf.Value> source_properties = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getState()

public abstract Finding.State getState()

The state of the finding.

.google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;

Returns
TypeDescription
Finding.State

The state.

getStateValue()

public abstract int getStateValue()

The state of the finding.

.google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 10;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEventTime()

public abstract boolean hasEventTime()

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.

.google.protobuf.Timestamp event_time = 9;

Returns
TypeDescription
boolean

Whether the eventTime field is set.

hasSecurityMarks()

public abstract boolean hasSecurityMarks()

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.

.google.cloud.securitycenter.v1p1beta1.SecurityMarks security_marks = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the securityMarks field is set.