com.google.cloud.securitycenter.v1p1beta1

Interface FindingOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Finding, Finding.Builder

public interface FindingOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsSourceProperties(String key) Source specific properties.
String	getCanonicalName() The canonical name of the finding.
ByteString	getCanonicalNameBytes() The canonical name of the finding.
String	getCategory() The additional taxonomy group within findings from a given source.
ByteString	getCategoryBytes() The additional taxonomy group within findings from a given source.
Timestamp	getCreateTime() The time at which the finding was created in Security Command Center.
TimestampOrBuilder	getCreateTimeOrBuilder() The time at which the finding was created in Security Command Center.
Timestamp	getEventTime() The time at which the event took place, or when an update to the finding occurred.
TimestampOrBuilder	getEventTimeOrBuilder() The time at which the event took place, or when an update to the finding occurred.
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.
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.
String	getName() The relative resource name of this finding.
ByteString	getNameBytes() The relative resource name of this finding.
String	getParent() The relative resource name of the source the finding belongs to.
ByteString	getParentBytes() The relative resource name of the source the finding belongs to.
String	getResourceName() For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for.
ByteString	getResourceNameBytes() For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for.
SecurityMarks	getSecurityMarks() Output only.
SecurityMarksOrBuilder	getSecurityMarksOrBuilder() Output only.
Finding.Severity	getSeverity() The severity of the finding.
int	getSeverityValue() The severity of the finding.
Map<String,Value>	getSourceProperties() Deprecated.
int	getSourcePropertiesCount() Source specific properties.
Map<String,Value>	getSourcePropertiesMap() Source specific properties.
Value	getSourcePropertiesOrDefault(String key, Value defaultValue) Source specific properties.
Value	getSourcePropertiesOrThrow(String key) Source specific properties.
Finding.State	getState() The state of the finding.
int	getStateValue() The state of the finding.
boolean	hasCreateTime() The time at which the finding was created in Security Command Center.
boolean	hasEventTime() The time at which the event took place, or when an update to the finding occurred.
boolean	hasSecurityMarks() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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:

The bytes for name.

getParent

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:

The parent.

getParentBytes

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:

The bytes for parent.

getResourceName

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:

The resourceName.

getResourceNameBytes

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:

The bytes for resourceName.

getStateValue

int getStateValue()

 The state of the finding.
 

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

Returns:

The enum numeric value on the wire for state.

getState

Finding.State getState()

 The state of the finding.
 

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

Returns:

The state.

getCategory

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:

The category.

getCategoryBytes

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:

The bytes for category.

getExternalUri

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:

The externalUri.

getExternalUriBytes

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:

The bytes for externalUri.

getSourcePropertiesCount

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;

containsSourceProperties

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;

getSourceProperties

@Deprecated
Map<String,Value> getSourceProperties()

Deprecated.

Use getSourcePropertiesMap() instead.

getSourcePropertiesMap

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;

getSourcePropertiesOrDefault

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;

getSourcePropertiesOrThrow

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;

hasSecurityMarks

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:

Whether the securityMarks field is set.

getSecurityMarks

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:

The securityMarks.

getSecurityMarksOrBuilder

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];

hasEventTime

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:

Whether the eventTime field is set.

getEventTime

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:

The eventTime.

getEventTimeOrBuilder

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;

hasCreateTime

boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 10;

Returns:

Whether the createTime field is set.

getCreateTime

Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 10;

Returns:

The createTime.

getCreateTimeOrBuilder

TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 10;

getSeverityValue

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:

The enum numeric value on the wire for severity.

getSeverity

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:

The severity.

getCanonicalName

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:

The canonicalName.

getCanonicalNameBytes

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:

The bytes for canonicalName.