Class: Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule

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

Overview

A Security Command Center resource that contains the configuration and enablement state of a custom module, which enables Event Threat Detection to write certain findings to Security Command Center.

Defined Under Namespace

Modules: EnablementState

Instance Attribute Summary collapse

Instance Attribute Details

#ancestor_module ⇒ ::String (readonly)

Returns Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the custom module's resource name.

Returns:

  • (::String) —

    Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the custom module's resource name.



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#config ⇒ ::Google::Protobuf::Struct

Returns Optional. Configuration for the module. For the resident module, its configuration value is defined at this level. For the inherited module, its configuration value is inherited from the ancestor module.

Returns:

  • (::Google::Protobuf::Struct) —

    Optional. Configuration for the module. For the resident module, its configuration value is defined at this level. For the inherited module, its configuration value is inherited from the ancestor module.



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#description ⇒ ::String

Returns Optional. A description of the module.

Returns:

  • (::String) —

    Optional. A description of the module.



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#display_name ⇒ ::String

Returns Optional. The human-readable name of the module.

Returns:

  • (::String) —

    Optional. The human-readable name of the module.



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#enablement_state ⇒ ::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule::EnablementState

Returns Optional. The state of enablement for the module at the given level of the hierarchy.

Returns:



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#last_editor ⇒ ::String (readonly)

Returns Output only. The editor the module was last updated by.

Returns:

  • (::String) —

    Output only. The editor the module was last updated by.



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the Event Threat Detection custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}.

Returns:

  • (::String) —

    Identifier. The resource name of the Event Threat Detection custom module, in one of the following formats:

    • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
    • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
    • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}


942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

#type ⇒ ::String

Returns Optional. Type for the module. For example, CONFIGURABLE_BAD_IP.

Returns:

  • (::String) —

    Optional. Type for the module. For example, CONFIGURABLE_BAD_IP.



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end

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

Returns Output only. The time the module was last updated.

Returns:



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 942

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

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

    # The module is disabled at the given level.
    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. If you try to set a top-level
    # module (a module with no parent) to the `INHERITED` state, you receive an
    # `INVALID_ARGUMENT` error.
    INHERITED = 3
  end
end