Class SecurityCenterService.Builder (0.21.0)

public static final class SecurityCenterService.Builder extends GeneratedMessageV3.Builder<SecurityCenterService.Builder> implements SecurityCenterServiceOrBuilder

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.

Protobuf type google.cloud.securitycentermanagement.v1.SecurityCenterService

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SecurityCenterService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityCenterService.Builder
Overrides

build()

public SecurityCenterService build()
Returns
Type Description
SecurityCenterService

buildPartial()

public SecurityCenterService buildPartial()
Returns
Type Description
SecurityCenterService

clear()

public SecurityCenterService.Builder clear()
Returns
Type Description
SecurityCenterService.Builder
Overrides

clearEffectiveEnablementState()

public SecurityCenterService.Builder clearEffectiveEnablementState()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SecurityCenterService.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecurityCenterService.Builder
Overrides

clearIntendedEnablementState()

public SecurityCenterService.Builder clearIntendedEnablementState()

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

This builder for chaining.

clearModules()

public SecurityCenterService.Builder clearModules()
Returns
Type Description
SecurityCenterService.Builder

clearName()

public SecurityCenterService.Builder clearName()

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
SecurityCenterService.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SecurityCenterService.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecurityCenterService.Builder
Overrides

clearServiceConfig()

public SecurityCenterService.Builder clearServiceConfig()

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
SecurityCenterService.Builder

clearUpdateTime()

public SecurityCenterService.Builder clearUpdateTime()

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
SecurityCenterService.Builder

clone()

public SecurityCenterService.Builder clone()
Returns
Type Description
SecurityCenterService.Builder
Overrides

containsModules(String key)

public 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

getDefaultInstanceForType()

public SecurityCenterService getDefaultInstanceForType()
Returns
Type Description
SecurityCenterService

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEffectiveEnablementState()

public 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 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 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 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 Map<String,SecurityCenterService.ModuleSettings> getModules()

Use #getModulesMap() instead.

Returns
Type Description
Map<String,ModuleSettings>

getModulesCount()

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

getMutableModules() (deprecated)

public Map<String,SecurityCenterService.ModuleSettings> getMutableModules()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,ModuleSettings>

getName()

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

getServiceConfigBuilder()

public Struct.Builder getServiceConfigBuilder()

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
Builder

getServiceConfigOrBuilder()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SecurityCenterService other)

public SecurityCenterService.Builder mergeFrom(SecurityCenterService other)
Parameter
Name Description
other SecurityCenterService
Returns
Type Description
SecurityCenterService.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecurityCenterService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecurityCenterService.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecurityCenterService.Builder
Overrides

mergeServiceConfig(Struct value)

public SecurityCenterService.Builder mergeServiceConfig(Struct value)

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

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

Parameter
Name Description
value Struct
Returns
Type Description
SecurityCenterService.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SecurityCenterService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityCenterService.Builder
Overrides

mergeUpdateTime(Timestamp value)

public SecurityCenterService.Builder mergeUpdateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityCenterService.Builder

putAllModules(Map<String,SecurityCenterService.ModuleSettings> values)

public SecurityCenterService.Builder putAllModules(Map<String,SecurityCenterService.ModuleSettings> values)

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
values Map<String,ModuleSettings>
Returns
Type Description
SecurityCenterService.Builder

putModules(String key, SecurityCenterService.ModuleSettings value)

public SecurityCenterService.Builder putModules(String key, SecurityCenterService.ModuleSettings value)

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
value SecurityCenterService.ModuleSettings
Returns
Type Description
SecurityCenterService.Builder

putModulesBuilderIfAbsent(String key)

public SecurityCenterService.ModuleSettings.Builder putModulesBuilderIfAbsent(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.Builder

removeModules(String key)

public SecurityCenterService.Builder removeModules(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.Builder

setEffectiveEnablementState(SecurityCenterService.EnablementState value)

public SecurityCenterService.Builder setEffectiveEnablementState(SecurityCenterService.EnablementState value)

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];

Parameter
Name Description
value SecurityCenterService.EnablementState

The effectiveEnablementState to set.

Returns
Type Description
SecurityCenterService.Builder

This builder for chaining.

setEffectiveEnablementStateValue(int value)

public SecurityCenterService.Builder setEffectiveEnablementStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for effectiveEnablementState to set.

Returns
Type Description
SecurityCenterService.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SecurityCenterService.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityCenterService.Builder
Overrides

setIntendedEnablementState(SecurityCenterService.EnablementState value)

public SecurityCenterService.Builder setIntendedEnablementState(SecurityCenterService.EnablementState value)

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];

Parameter
Name Description
value SecurityCenterService.EnablementState

The intendedEnablementState to set.

Returns
Type Description
SecurityCenterService.Builder

This builder for chaining.

setIntendedEnablementStateValue(int value)

public SecurityCenterService.Builder setIntendedEnablementStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for intendedEnablementState to set.

Returns
Type Description
SecurityCenterService.Builder

This builder for chaining.

setName(String value)

public SecurityCenterService.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SecurityCenterService.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SecurityCenterService.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SecurityCenterService.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SecurityCenterService.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecurityCenterService.Builder
Overrides

setServiceConfig(Struct value)

public SecurityCenterService.Builder setServiceConfig(Struct value)

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

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

Parameter
Name Description
value Struct
Returns
Type Description
SecurityCenterService.Builder

setServiceConfig(Struct.Builder builderForValue)

public SecurityCenterService.Builder setServiceConfig(Struct.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SecurityCenterService.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SecurityCenterService.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityCenterService.Builder
Overrides

setUpdateTime(Timestamp value)

public SecurityCenterService.Builder setUpdateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityCenterService.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public SecurityCenterService.Builder setUpdateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SecurityCenterService.Builder