Reference documentation and code samples for the Security Center Management V1 API class Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ancestor_module
def ancestor_module() -> ::String
Returns
- (::String) — Output only. Specifies the organization or folder from which the custom module is inherited. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module.
#custom_config
def custom_config() -> ::Google::Cloud::SecurityCenterManagement::V1::CustomConfig
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::CustomConfig) — Optional. The user specified custom configuration for the module.
#custom_config=
def custom_config=(value) -> ::Google::Cloud::SecurityCenterManagement::V1::CustomConfig
Parameter
- value (::Google::Cloud::SecurityCenterManagement::V1::CustomConfig) — Optional. The user specified custom configuration for the module.
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::CustomConfig) — Optional. The user specified custom configuration for the module.
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. 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.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. 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.
Returns
- (::String) — Optional. 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.
#enablement_state
def enablement_state() -> ::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule::EnablementState
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule::EnablementState) — Optional. The enablement state of the custom module.
#enablement_state=
def enablement_state=(value) -> ::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule::EnablementState
Parameter
- value (::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule::EnablementState) — Optional. The enablement state of the custom module.
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule::EnablementState) — Optional. The enablement state of the custom module.
#last_editor
def last_editor() -> ::String
Returns
- (::String) — Output only. The editor that last updated the custom module.
#name
def name() -> ::String
Returns
-
(::String) —
Identifier. The full resource name of the custom module, specified in one of the following formats:
organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) —
Identifier. The full resource name of the custom module, specified in one of the following formats:
organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}
Returns
-
(::String) —
Identifier. The full resource name of the custom module, specified in one of the following formats:
organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the custom module was last updated.