Security Center Management V1 API - Class Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule (v0.2.1)

Reference documentation and code samples for the Security Center Management V1 API class Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule.

An EffectiveEventThreatDetectionCustomModule is the representation of EventThreatDetectionCustomModule at a given level taking hierarchy into account and resolving various fields accordingly. e.g. if the module is enabled at the ancestor level, effective modules at all descendant levels will have enablement_state set to ENABLED. Similarly, if module.inherited is set, then effective module's config will contain the ancestor's config details. EffectiveEventThreatDetectionCustomModule is read-only.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#config

def config() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) — Output only. Config for the effective module.

#description

def description() -> ::String

Returns

(::String) — Output only. The description for the module.

#display_name

def display_name() -> ::String

Returns

(::String) — Output only. The human readable name to be displayed for the module.

#enablement_state

def enablement_state() -> ::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule::EnablementState

Returns

(::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule::EnablementState) — Output only. The effective state of enablement for the module at the given level of the hierarchy.

#name

def name() -> ::String

Returns

(::String) —
Identifier. The resource name of the ETD custom module.

Its format is:
- organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
- folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
- projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.

#name=

def name=(value) -> ::String

Parameter

value (::String) —
Identifier. The resource name of the ETD custom module.

Its format is:
- organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
- folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
- projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.

Returns

(::String) —
Identifier. The resource name of the ETD custom module.

Its format is:
- organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
- folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
- projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.

#type

def type() -> ::String

Returns

(::String) — Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.