Reference documentation and code samples for the Security Center Management V1 API class Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService.
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 child folders and projects.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#effective_enablement_state
def effective_enablement_state() -> ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState) — 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.
#intended_enablement_state
def intended_enablement_state() -> ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState) — Optional. The intended state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
#intended_enablement_state=
def intended_enablement_state=(value) -> ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState
Parameter
- value (::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState) — Optional. The intended state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
Returns
- (::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::EnablementState) — Optional. The intended state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
#modules
def modules() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings}
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings}) — Optional. The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parents.
#modules=
def modules=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings}
Parameter
- value (::Google::Protobuf::Map{::String => ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings}) — Optional. The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parents.
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService::ModuleSettings}) — Optional. The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parents.
#name
def name() -> ::String
Returns
-
(::String) —
Identifier. The name of the service.
Its format is:
- organizations/{organization}/locations/{location}/securityCenterServices/{service}
- folders/{folder}/locations/{location}/securityCenterServices/{service}
- projects/{project}/locations/{location}/securityCenterServices/{service}
The possible values for id {service} are:
- container-threat-detection
- event-threat-detection
- security-health-analytics
- vm-threat-detection
- web-security-scanner
#name=
def name=(value) -> ::String
Parameter
-
value (::String) —
Identifier. The name of the service.
Its format is:
- organizations/{organization}/locations/{location}/securityCenterServices/{service}
- folders/{folder}/locations/{location}/securityCenterServices/{service}
- projects/{project}/locations/{location}/securityCenterServices/{service}
The possible values for id {service} are:
- container-threat-detection
- event-threat-detection
- security-health-analytics
- vm-threat-detection
- web-security-scanner
Returns
-
(::String) —
Identifier. The name of the service.
Its format is:
- organizations/{organization}/locations/{location}/securityCenterServices/{service}
- folders/{folder}/locations/{location}/securityCenterServices/{service}
- projects/{project}/locations/{location}/securityCenterServices/{service}
The possible values for id {service} are:
- container-threat-detection
- event-threat-detection
- security-health-analytics
- vm-threat-detection
- web-security-scanner
#service_config
def service_config() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Optional. Additional service specific configuration. Not all services will utilize this field.
#service_config=
def service_config=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Optional. Additional service specific configuration. Not all services will utilize this field.
Returns
- (::Google::Protobuf::Struct) — Optional. Additional service specific configuration. Not all services will utilize this field.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
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.