Cloud Security Command Center V1 API - Class Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule (v0.40.0)

Version latest

• 0.40.0 (latest)
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.2
• 0.33.0
• 0.32.0
• 0.31.1
• 0.30.0
• 0.29.1
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.1
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.1
• 0.11.1

Reference documentation and code samples for the Cloud Security Command Center V1 API class Google::Cloud::SecurityCenter::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. 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.

#custom_config

def custom_config() -> ::Google::Cloud::SecurityCenter::V1::CustomConfig

Returns

• (::Google::Cloud::SecurityCenter::V1::CustomConfig) — The user specified custom configuration for the module.

#custom_config=

def custom_config=(value) -> ::Google::Cloud::SecurityCenter::V1::CustomConfig

Parameter

• value (::Google::Cloud::SecurityCenter::V1::CustomConfig) — The user specified custom configuration for the module.

Returns

• (::Google::Cloud::SecurityCenter::V1::CustomConfig) — The user specified custom configuration for the module.

#display_name

def display_name() -> ::String

Returns

• (::String) — 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) — 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) — 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::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule::EnablementState

Returns

• (::Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule::EnablementState) — The enablement state of the custom module.

#enablement_state=

def enablement_state=(value) -> ::Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule::EnablementState

Parameter

• value (::Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule::EnablementState) — The enablement state of the custom module.

Returns

• (::Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule::EnablementState) — 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) — 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.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time at which the custom module was last updated.