Class Finding (2.11.1)

public final class Finding extends GeneratedMessageV3 implements FindingOrBuilder

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.

Protobuf type google.cloud.securitycenter.v1p1beta1.Finding

Implements

FindingOrBuilder

Static Fields

CANONICAL_NAME_FIELD_NUMBER

public static final int CANONICAL_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_TIME_FIELD_NUMBER

public static final int EVENT_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

EXTERNAL_URI_FIELD_NUMBER

public static final int EXTERNAL_URI_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_NAME_FIELD_NUMBER

public static final int RESOURCE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SECURITY_MARKS_FIELD_NUMBER

public static final int SECURITY_MARKS_FIELD_NUMBER
Field Value
TypeDescription
int

SEVERITY_FIELD_NUMBER

public static final int SEVERITY_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_PROPERTIES_FIELD_NUMBER

public static final int SOURCE_PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Finding getDefaultInstance()
Returns
TypeDescription
Finding

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Finding.Builder newBuilder()
Returns
TypeDescription
Finding.Builder

newBuilder(Finding prototype)

public static Finding.Builder newBuilder(Finding prototype)
Parameter
NameDescription
prototypeFinding
Returns
TypeDescription
Finding.Builder

parseDelimitedFrom(InputStream input)

public static Finding parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Finding
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Finding parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Finding
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Finding parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Finding
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Finding
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Finding parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Finding
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Finding
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Finding parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Finding
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Finding
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Finding parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Finding
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Finding
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Finding parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Finding
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Finding
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Finding> parser()
Returns
TypeDescription
Parser<Finding>

Methods

containsSourceProperties(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCanonicalName()

public 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 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 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 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 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 TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 10;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Finding getDefaultInstanceForType()
Returns
TypeDescription
Finding

getEventTime()

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

getParserForType()

public Parser<Finding> getParserForType()
Returns
TypeDescription
Parser<Finding>
Overrides

getResourceName()

public 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 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 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 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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSeverity()

public 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 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 Map<String,Value> getSourceProperties()
Returns
TypeDescription
Map<String,Value>

getSourcePropertiesCount()

public 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 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 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 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 Finding.State getState()

The state of the finding.

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

Returns
TypeDescription
Finding.State

The state.

getStateValue()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreateTime()

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

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Finding.Builder newBuilderForType()
Returns
TypeDescription
Finding.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Finding.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Finding.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Finding.Builder toBuilder()
Returns
TypeDescription
Finding.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException