Package com.google.cloud.securitycenter.v1

Class SecurityHealthAnalyticsCustomModule.Builder

  • All Implemented Interfaces:
    SecurityHealthAnalyticsCustomModuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    SecurityHealthAnalyticsCustomModule
    public static final class SecurityHealthAnalyticsCustomModule.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SecurityHealthAnalyticsCustomModule.Builder>
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

    • Method Detail

      • 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.Builder<SecurityHealthAnalyticsCustomModule.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityHealthAnalyticsCustomModule.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

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

      • setName

        public SecurityHealthAnalyticsCustomModule.Builder setName​(String value)
         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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public SecurityHealthAnalyticsCustomModule.Builder clearName()
         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];
        Returns:
        This builder for chaining.

      • setNameBytes

        public SecurityHealthAnalyticsCustomModule.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setDisplayName

        public SecurityHealthAnalyticsCustomModule.Builder setDisplayName​(String value)
         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;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public SecurityHealthAnalyticsCustomModule.Builder clearDisplayName()
         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;
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public SecurityHealthAnalyticsCustomModule.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

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

      • setEnablementStateValue

        public SecurityHealthAnalyticsCustomModule.Builder setEnablementStateValue​(int value)
         The enablement state of the custom module.
        .google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;
        Parameters:
        value - The enum numeric value on the wire for enablementState to set.
        Returns:
        This builder for chaining.

      • clearEnablementState

        public SecurityHealthAnalyticsCustomModule.Builder clearEnablementState()
         The enablement state of the custom module.
        .google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;
        Returns:
        This builder for chaining.

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

      • setUpdateTime

        public SecurityHealthAnalyticsCustomModule.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setUpdateTime

        public SecurityHealthAnalyticsCustomModule.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeUpdateTime

        public SecurityHealthAnalyticsCustomModule.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearUpdateTime

        public SecurityHealthAnalyticsCustomModule.Builder clearUpdateTime()
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. The time at which the custom module was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

      • setLastEditor

        public SecurityHealthAnalyticsCustomModule.Builder setLastEditor​(String value)
         Output only. The editor that last updated the custom module.
        string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The lastEditor to set.
        Returns:
        This builder for chaining.

      • clearLastEditor

        public SecurityHealthAnalyticsCustomModule.Builder clearLastEditor()
         Output only. The editor that last updated the custom module.
        string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setLastEditorBytes

        public SecurityHealthAnalyticsCustomModule.Builder setLastEditorBytes​(com.google.protobuf.ByteString value)
         Output only. The editor that last updated the custom module.
        string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for lastEditor to set.
        Returns:
        This builder for chaining.

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

      • setAncestorModule

        public SecurityHealthAnalyticsCustomModule.Builder setAncestorModule​(String value)
         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) = { ... }
        Parameters:
        value - The ancestorModule to set.
        Returns:
        This builder for chaining.

      • clearAncestorModule

        public SecurityHealthAnalyticsCustomModule.Builder clearAncestorModule()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setAncestorModuleBytes

        public SecurityHealthAnalyticsCustomModule.Builder setAncestorModuleBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for ancestorModule to set.
        Returns:
        This builder for chaining.

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

      • getCustomConfigBuilder

        public CustomConfig.Builder getCustomConfigBuilder()
         The user specified custom configuration for the module.
        .google.cloud.securitycenter.v1.CustomConfig custom_config = 8;