Interface SecurityCenterServiceOrBuilder (0.15.0) 

public interface SecurityCenterServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsModules(String key)

public abstract boolean containsModules(String key)

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.

map<string, .google.cloud.securitycentermanagement.v1.SecurityCenterService.ModuleSettings> modules = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getEffectiveEnablementState()

public abstract SecurityCenterService.EnablementState 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.

.google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SecurityCenterService.EnablementState

The effectiveEnablementState.

getEffectiveEnablementStateValue()

public abstract int getEffectiveEnablementStateValue()

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.

.google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for effectiveEnablementState.

getIntendedEnablementState()

public abstract SecurityCenterService.EnablementState 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.

.google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SecurityCenterService.EnablementState

The intendedEnablementState.

getIntendedEnablementStateValue()

public abstract int getIntendedEnablementStateValue()

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.

.google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for intendedEnablementState.

getModules() (deprecated)

public abstract Map<String,SecurityCenterService.ModuleSettings> getModules()

Use #getModulesMap() instead.

Returns
Type Description
Map<String,ModuleSettings>

getModulesCount()

public abstract int getModulesCount()

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.

map<string, .google.cloud.securitycentermanagement.v1.SecurityCenterService.ModuleSettings> modules = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getModulesMap()

public abstract Map<String,SecurityCenterService.ModuleSettings> getModulesMap()

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.

map<string, .google.cloud.securitycentermanagement.v1.SecurityCenterService.ModuleSettings> modules = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,ModuleSettings>

getModulesOrDefault(String key, SecurityCenterService.ModuleSettings defaultValue)

public abstract SecurityCenterService.ModuleSettings getModulesOrDefault(String key, SecurityCenterService.ModuleSettings defaultValue)

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.

map<string, .google.cloud.securitycentermanagement.v1.SecurityCenterService.ModuleSettings> modules = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue SecurityCenterService.ModuleSettings
Returns
Type Description
SecurityCenterService.ModuleSettings

getModulesOrThrow(String key)

public abstract SecurityCenterService.ModuleSettings getModulesOrThrow(String key)

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.

map<string, .google.cloud.securitycentermanagement.v1.SecurityCenterService.ModuleSettings> modules = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
SecurityCenterService.ModuleSettings

getName()

public abstract String 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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getServiceConfig()

public abstract Struct getServiceConfig()

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

.google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The serviceConfig.

getServiceConfigOrBuilder()

public abstract StructOrBuilder getServiceConfigOrBuilder()

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

.google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getUpdateTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasServiceConfig()

public abstract boolean hasServiceConfig()

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

.google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the serviceConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.