Package com.google.cloud.securitycenter.v1p1beta1

Class Finding

  • All Implemented Interfaces:
    FindingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Finding
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Finding.Builder
      Security Command Center finding.
      static class  Finding.Severity
      The severity of the finding.
      static class  Finding.State
      The state of the finding.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        getName in interface FindingOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface FindingOrBuilder
        Returns:
        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;
        Specified by:
        getParent in interface FindingOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.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;
        Specified by:
        getParentBytes in interface FindingOrBuilder
        Returns:
        The bytes for parent.

      • 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;
        Specified by:
        getResourceName in interface FindingOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.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;
        Specified by:
        getResourceNameBytes in interface FindingOrBuilder
        Returns:
        The bytes for resourceName.

      • getStateValue

        public int getStateValue()
         The state of the finding.
        .google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;
        Specified by:
        getStateValue in interface FindingOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Finding.State getState()
         The state of the finding.
        .google.cloud.securitycenter.v1p1beta1.Finding.State state = 4;
        Specified by:
        getState in interface FindingOrBuilder
        Returns:
        The state.

      • 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;
        Specified by:
        getCategory in interface FindingOrBuilder
        Returns:
        The category.

      • getCategoryBytes

        public com.google.protobuf.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;
        Specified by:
        getCategoryBytes in interface FindingOrBuilder
        Returns:
        The bytes for category.

      • 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;
        Specified by:
        getExternalUri in interface FindingOrBuilder
        Returns:
        The externalUri.

      • getExternalUriBytes

        public com.google.protobuf.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;
        Specified by:
        getExternalUriBytes in interface FindingOrBuilder
        Returns:
        The bytes for externalUri.

      • getSourcePropertiesCount

        public int getSourcePropertiesCount()
        Description copied from interface: FindingOrBuilder
         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;
        Specified by:
        getSourcePropertiesCount in interface FindingOrBuilder

      • containsSourceProperties

        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;
        Specified by:
        containsSourceProperties in interface FindingOrBuilder

      • getSourcePropertiesMap

        public Map<String,​com.google.protobuf.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;
        Specified by:
        getSourcePropertiesMap in interface FindingOrBuilder

      • getSourcePropertiesOrDefault

        public com.google.protobuf.Value getSourcePropertiesOrDefault​(String key,
                                                              com.google.protobuf.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;
        Specified by:
        getSourcePropertiesOrDefault in interface FindingOrBuilder

      • getSourcePropertiesOrThrow

        public com.google.protobuf.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;
        Specified by:
        getSourcePropertiesOrThrow in interface FindingOrBuilder

      • 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];
        Specified by:
        hasSecurityMarks in interface FindingOrBuilder
        Returns:
        Whether the securityMarks field is set.

      • 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];
        Specified by:
        getSecurityMarks in interface FindingOrBuilder
        Returns:
        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];
        Specified by:
        getSecurityMarksOrBuilder in interface FindingOrBuilder

      • 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;
        Specified by:
        hasEventTime in interface FindingOrBuilder
        Returns:
        Whether the eventTime field is set.

      • getEventTime

        public com.google.protobuf.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;
        Specified by:
        getEventTime in interface FindingOrBuilder
        Returns:
        The eventTime.

      • getEventTimeOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getEventTimeOrBuilder in interface FindingOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         The time at which the finding was created in Security Command Center.
        .google.protobuf.Timestamp create_time = 10;
        Specified by:
        hasCreateTime in interface FindingOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         The time at which the finding was created in Security Command Center.
        .google.protobuf.Timestamp create_time = 10;
        Specified by:
        getCreateTime in interface FindingOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The time at which the finding was created in Security Command Center.
        .google.protobuf.Timestamp create_time = 10;
        Specified by:
        getCreateTimeOrBuilder in interface FindingOrBuilder

      • 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;
        Specified by:
        getSeverityValue in interface FindingOrBuilder
        Returns:
        The enum numeric value on the wire for severity.

      • 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;
        Specified by:
        getSeverity in interface FindingOrBuilder
        Returns:
        The severity.

      • 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;
        Specified by:
        getCanonicalName in interface FindingOrBuilder
        Returns:
        The canonicalName.

      • getCanonicalNameBytes

        public com.google.protobuf.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;
        Specified by:
        getCanonicalNameBytes in interface FindingOrBuilder
        Returns:
        The bytes for canonicalName.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Finding parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Finding parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Finding parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Finding parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Finding parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Finding parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Finding parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Finding.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Finding.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Finding.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Finding getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Finding> parser()

      • getParserForType

        public com.google.protobuf.Parser<Finding> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Finding getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder