Class: Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb

Overview

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.

Defined Under Namespace

Modules: EnablementState

Instance Attribute Summary collapse

Instance Attribute Details

#ancestor_module ⇒ ::String (readonly)

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

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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end

#custom_config ⇒ ::Google::Cloud::SecurityCenter::V1::CustomConfig

Returns The user specified custom configuration for the module.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end

#display_name ⇒ ::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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end

#enablement_state ⇒ ::Google::Cloud::SecurityCenter::V1::SecurityHealthAnalyticsCustomModule::EnablementState

Returns The enablement state of the custom module.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end

#last_editor ⇒ ::String (readonly)

Returns Output only. The editor that last updated the custom module.

Returns:

  • (::String) —

    Output only. The editor that last updated the custom module.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end

#name ⇒ ::String

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the custom module was last updated.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_module.rb', line 66

class SecurityHealthAnalyticsCustomModule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible enablement states of a custom module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given CRM resource.
    ENABLED = 1

    # The module is disabled at the given CRM resource.
    DISABLED = 2

    # State is inherited from an ancestor module. The module will either
    # be effectively ENABLED or DISABLED based on its closest non-inherited
    # ancestor module in the CRM hierarchy.
    INHERITED = 3
  end
end