Class: Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule

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

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 descendant folders and projects.

Defined Under Namespace

Modules: EnablementState

Instance Attribute Summary collapse

Instance Attribute Details

#ancestor_module ⇒ ::String (readonly)

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

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.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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

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

Returns Optional. The user-specified custom configuration for the module.

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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

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.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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::SecurityHealthAnalyticsCustomModule::EnablementState

Returns Optional. The enablement state of the custom module.

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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 that last updated the custom module.

Returns:

  • (::String) —

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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 full resource name of the custom module, in one of the following formats:

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

Returns:

  • (::String) —

    Identifier. The full resource name of the custom module, in one of the following formats:

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


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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 at which the custom module was last updated.

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 260

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

  # Possible enablement states of a custom module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given organization, folder, or project.
    ENABLED = 1

    # The module is disabled at the given organization, folder, or project.
    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 resource 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