Package com.google.cloud.securitycenter.v1

Class SecurityHealthAnalyticsCustomModule

  • All Implemented Interfaces:
    SecurityHealthAnalyticsCustomModuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SecurityHealthAnalyticsCustomModule
extends com.google.protobuf.GeneratedMessageV3
implements SecurityHealthAnalyticsCustomModuleOrBuilder
     Represents an instance of a Security Health Analytics custom module,
 including its full module name, display name, enablement state, and last
 updated time. You can create a custom module at the organization, folder, or
 project level. Custom modules that you create at the organization or folder
 level are inherited by the child folders and projects.
    Protobuf type google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule
    See Also:
    Serialized Form

    • 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()

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Immutable. The resource name of the custom module.
 Its format is
 "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}",
 or
 "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}",
 or
 "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

 The id {customModule} is server-generated and is not user settable.
 It will be a numeric id containing 1-20 digits.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. The resource name of the custom module.
 Its format is
 "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}",
 or
 "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}",
 or
 "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

 The id {customModule} is server-generated and is not user settable.
 It will be a numeric id containing 1-20 digits.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         The display name of the Security Health Analytics custom module. This
 display name becomes the finding category for all findings that are
 returned by this custom module. The display name must be between 1 and
 128 characters, start with a lowercase letter, and contain alphanumeric
 characters or underscores only.
        string display_name = 2;
        Specified by:
        getDisplayName in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The display name of the Security Health Analytics custom module. This
 display name becomes the finding category for all findings that are
 returned by this custom module. The display name must be between 1 and
 128 characters, start with a lowercase letter, and contain alphanumeric
 characters or underscores only.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The bytes for displayName.

      • getEnablementStateValue

        public int getEnablementStateValue()
         The enablement state of the custom module.
        .google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;
        Specified by:
        getEnablementStateValue in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The enum numeric value on the wire for enablementState.

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface SecurityHealthAnalyticsCustomModuleOrBuilder

      • getLastEditorBytes

        public com.google.protobuf.ByteString getLastEditorBytes()
         Output only. The editor that last updated the custom module.
        string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLastEditorBytes in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The bytes for lastEditor.

      • getAncestorModule

        public String getAncestorModule()
         Output only. If empty, indicates that the custom module was created in the
 organization, folder, or project in which you are viewing the custom
 module. Otherwise, `ancestor_module` specifies the organization or folder
 from which the custom module is inherited.
        string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAncestorModule in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The ancestorModule.

      • getAncestorModuleBytes

        public com.google.protobuf.ByteString getAncestorModuleBytes()
         Output only. If empty, indicates that the custom module was created in the
 organization, folder, or project in which you are viewing the custom
 module. Otherwise, `ancestor_module` specifies the organization or folder
 from which the custom module is inherited.
        string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAncestorModuleBytes in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        The bytes for ancestorModule.

      • hasCustomConfig

        public boolean hasCustomConfig()
         The user specified custom configuration for the module.
        .google.cloud.securitycenter.v1.CustomConfig custom_config = 8;
        Specified by:
        hasCustomConfig in interface SecurityHealthAnalyticsCustomModuleOrBuilder
        Returns:
        Whether the customConfig field is set.

      • 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 SecurityHealthAnalyticsCustomModule parseFrom​(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<SecurityHealthAnalyticsCustomModule> 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 SecurityHealthAnalyticsCustomModule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder