Class SecurityCenterService (0.44.0) 

public final class SecurityCenterService extends GeneratedMessageV3 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 descendant folders and projects.

Protobuf type google.cloud.securitycentermanagement.v1.SecurityCenterService

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecurityCenterService

Static Fields

EFFECTIVE_ENABLEMENT_STATE_FIELD_NUMBER

public static final int EFFECTIVE_ENABLEMENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

INTENDED_ENABLEMENT_STATE_FIELD_NUMBER

public static final int INTENDED_ENABLEMENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

MODULES_FIELD_NUMBER

public static final int MODULES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_CONFIG_FIELD_NUMBER

public static final int SERVICE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecurityCenterService getDefaultInstance()
Returns
Type Description
SecurityCenterService

getDescriptor()

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

newBuilder()

public static SecurityCenterService.Builder newBuilder()
Returns
Type Description
SecurityCenterService.Builder

newBuilder(SecurityCenterService prototype)

public static SecurityCenterService.Builder newBuilder(SecurityCenterService prototype)
Parameter
Name Description
prototype SecurityCenterService
Returns
Type Description
SecurityCenterService.Builder

parseDelimitedFrom(InputStream input)

public static SecurityCenterService parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityCenterService parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecurityCenterService parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecurityCenterService parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecurityCenterService parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecurityCenterService parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecurityCenterService parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityCenterService parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecurityCenterService parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityCenterService parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecurityCenterService parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecurityCenterService parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityCenterService
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecurityCenterService> parser()
Returns
Type Description
Parser<SecurityCenterService>

Methods

containsModules(String key)

public boolean containsModules(String key)

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.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SecurityCenterService getDefaultInstanceForType()
Returns
Type Description
SecurityCenterService

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 enablement state 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 enablement state 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 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.

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

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

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

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 String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SecurityCenterService> getParserForType()
Returns
Type Description
Parser<SecurityCenterService>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecurityCenterService.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecurityCenterService.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException