Google Cloud Security Center Management V1 Client - Class SecurityCenterService (0.3.2)

Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class 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.

Generated from protobuf message google.cloud.securitycentermanagement.v1.SecurityCenterService

Namespace

Google \ Cloud \ SecurityCenterManagement \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name 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
↳ intended_enablement_state int

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.
↳ effective_enablement_state int

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.
↳ modules array|Google\Protobuf\Internal\MapField

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.
↳ update_time 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.
↳ service_config Google\Protobuf\Struct

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

getName

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
Type Description
string

setName

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
Parameter
Name Description
var string
Returns
Type Description
$this

getIntendedEnablementState

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
Type Description
int

setIntendedEnablementState

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getEffectiveEnablementState

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
Type Description
int

setEffectiveEnablementState

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getModules

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
Type Description
Google\Protobuf\Internal\MapField

setModules

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getUpdateTime

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
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getServiceConfig

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

Returns
Type Description
Google\Protobuf\Struct|null

hasServiceConfig

clearServiceConfig

setServiceConfig

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

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this