Class: Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService

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 a particular Security Command Center service. This includes settings information such as top-level enablement in addition to individual module settings. Service settings can be configured at the organization, folder, or project level. Service settings at the organization or folder level are inherited by those in descendant folders and projects.

Defined Under Namespace

Modules: EnablementState Classes: ModuleSettings, ModulesEntry

Instance Attribute Summary collapse

Instance Attribute Details

#effective_enablement_state ⇒ ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState (readonly)

Returns Output only. The effective enablement state for the service at its level of the resource hierarchy. If the intended state is set to INHERITED, the effective state will be inherited from the enablement state of an ancestor. This state may differ from the intended enablement state due to billing eligibility or onboarding status.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 70

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

  # The settings for individual modules.
  # @!attribute [rw] intended_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Optional. The intended enablement state for the module at its level of
  #     the resource hierarchy.
  # @!attribute [r] effective_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Output only. The effective enablement state for the module at its level
  #     of the resource hierarchy. If the intended state is set to `INHERITED`,
  #     the effective state will be inherited from the enablement state of an
  #     ancestor. This state may differ from the intended enablement state due to
  #     billing eligibility or onboarding status.
  class ModuleSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings]
  class ModulesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the possible enablement states for a service or module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # State is inherited from the parent resource. Valid as an intended
    # enablement state, but not as an effective enablement state.
    INHERITED = 1

    # State is enabled.
    ENABLED = 2

    # State is disabled.
    DISABLED = 3

    # Security Command Center is configured to ingest findings from this
    # service, but not to enable this service. This state indicates that
    # Security Command Center is misconfigured. You can't set this state
    # yourself.
    INGEST_ONLY = 4
  end
end

#intended_enablement_state ⇒ ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState

Returns Optional. The intended enablement state for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement states to DISABLED.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 70

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

  # The settings for individual modules.
  # @!attribute [rw] intended_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Optional. The intended enablement state for the module at its level of
  #     the resource hierarchy.
  # @!attribute [r] effective_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Output only. The effective enablement state for the module at its level
  #     of the resource hierarchy. If the intended state is set to `INHERITED`,
  #     the effective state will be inherited from the enablement state of an
  #     ancestor. This state may differ from the intended enablement state due to
  #     billing eligibility or onboarding status.
  class ModuleSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings]
  class ModulesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the possible enablement states for a service or module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # State is inherited from the parent resource. Valid as an intended
    # enablement state, but not as an effective enablement state.
    INHERITED = 1

    # State is enabled.
    ENABLED = 2

    # State is disabled.
    DISABLED = 3

    # Security Command Center is configured to ingest findings from this
    # service, but not to enable this service. This state indicates that
    # Security Command Center is misconfigured. You can't set this state
    # yourself.
    INGEST_ONLY = 4
  end
end

#modules ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings}

Returns Optional. The module configurations, including the enablement state for the service's modules. The absence of a module in the map implies that its configuration is inherited from its parents.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 70

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

  # The settings for individual modules.
  # @!attribute [rw] intended_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Optional. The intended enablement state for the module at its level of
  #     the resource hierarchy.
  # @!attribute [r] effective_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Output only. The effective enablement state for the module at its level
  #     of the resource hierarchy. If the intended state is set to `INHERITED`,
  #     the effective state will be inherited from the enablement state of an
  #     ancestor. This state may differ from the intended enablement state due to
  #     billing eligibility or onboarding status.
  class ModuleSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings]
  class ModulesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the possible enablement states for a service or module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # State is inherited from the parent resource. Valid as an intended
    # enablement state, but not as an effective enablement state.
    INHERITED = 1

    # State is enabled.
    ENABLED = 2

    # State is disabled.
    DISABLED = 3

    # Security Command Center is configured to ingest findings from this
    # service, but not to enable this service. This state indicates that
    # Security Command Center is misconfigured. You can't set this state
    # yourself.
    INGEST_ONLY = 4
  end
end

#name ⇒ ::String

Returns Identifier. The name of the service, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityCenterServices/{service}
  • folders/{folder}/locations/{location}/securityCenterServices/{service}
  • projects/{project}/locations/{location}/securityCenterServices/{service}

The following values are valid for {service}:

  • container-threat-detection
  • event-threat-detection
  • security-health-analytics
  • vm-threat-detection
  • web-security-scanner.

Returns:

  • (::String) —

    Identifier. The name of the service, in one of the following formats:

    • organizations/{organization}/locations/{location}/securityCenterServices/{service}
    • folders/{folder}/locations/{location}/securityCenterServices/{service}
    • projects/{project}/locations/{location}/securityCenterServices/{service}

    The following values are valid for {service}:

    • container-threat-detection
    • event-threat-detection
    • security-health-analytics
    • vm-threat-detection
    • web-security-scanner


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 70

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

  # The settings for individual modules.
  # @!attribute [rw] intended_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Optional. The intended enablement state for the module at its level of
  #     the resource hierarchy.
  # @!attribute [r] effective_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Output only. The effective enablement state for the module at its level
  #     of the resource hierarchy. If the intended state is set to `INHERITED`,
  #     the effective state will be inherited from the enablement state of an
  #     ancestor. This state may differ from the intended enablement state due to
  #     billing eligibility or onboarding status.
  class ModuleSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings]
  class ModulesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the possible enablement states for a service or module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # State is inherited from the parent resource. Valid as an intended
    # enablement state, but not as an effective enablement state.
    INHERITED = 1

    # State is enabled.
    ENABLED = 2

    # State is disabled.
    DISABLED = 3

    # Security Command Center is configured to ingest findings from this
    # service, but not to enable this service. This state indicates that
    # Security Command Center is misconfigured. You can't set this state
    # yourself.
    INGEST_ONLY = 4
  end
end

#service_config ⇒ ::Google::Protobuf::Struct

Returns Optional. Additional service-specific configuration. Not all services will utilize this field.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 70

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

  # The settings for individual modules.
  # @!attribute [rw] intended_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Optional. The intended enablement state for the module at its level of
  #     the resource hierarchy.
  # @!attribute [r] effective_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Output only. The effective enablement state for the module at its level
  #     of the resource hierarchy. If the intended state is set to `INHERITED`,
  #     the effective state will be inherited from the enablement state of an
  #     ancestor. This state may differ from the intended enablement state due to
  #     billing eligibility or onboarding status.
  class ModuleSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings]
  class ModulesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the possible enablement states for a service or module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # State is inherited from the parent resource. Valid as an intended
    # enablement state, but not as an effective enablement state.
    INHERITED = 1

    # State is enabled.
    ENABLED = 2

    # State is disabled.
    DISABLED = 3

    # Security Command Center is configured to ingest findings from this
    # service, but not to enable this service. This state indicates that
    # Security Command Center is misconfigured. You can't set this state
    # yourself.
    INGEST_ONLY = 4
  end
end

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

Returns Output only. The time the service was last updated. This could be due to an explicit user update or due to a side effect of another system change, such as billing subscription expiry.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The time the service was last updated. This could be due to an explicit user update or due to a side effect of another system change, such as billing subscription expiry.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 70

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

  # The settings for individual modules.
  # @!attribute [rw] intended_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Optional. The intended enablement state for the module at its level of
  #     the resource hierarchy.
  # @!attribute [r] effective_enablement_state
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState]
  #     Output only. The effective enablement state for the module at its level
  #     of the resource hierarchy. If the intended state is set to `INHERITED`,
  #     the effective state will be inherited from the enablement state of an
  #     ancestor. This state may differ from the intended enablement state due to
  #     billing eligibility or onboarding status.
  class ModuleSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings]
  class ModulesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the possible enablement states for a service or module.
  module EnablementState
    # Default value. This value is unused.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # State is inherited from the parent resource. Valid as an intended
    # enablement state, but not as an effective enablement state.
    INHERITED = 1

    # State is enabled.
    ENABLED = 2

    # State is disabled.
    DISABLED = 3

    # Security Command Center is configured to ingest findings from this
    # service, but not to enable this service. This state indicates that
    # Security Command Center is misconfigured. You can't set this state
    # yourself.
    INGEST_ONLY = 4
  end
end