Class ComponentSettings (0.25.0) 

public final class ComponentSettings extends GeneratedMessageV3 implements ComponentSettingsOrBuilder

Component Settings for Security Command Center

Protobuf type google.cloud.securitycenter.settings.v1beta1.ComponentSettings

Inheritance

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

Static Fields

CONTAINER_THREAT_DETECTION_SETTINGS_FIELD_NUMBER

public static final int CONTAINER_THREAT_DETECTION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DETECTOR_SETTINGS_FIELD_NUMBER

public static final int DETECTOR_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

EVENT_THREAT_DETECTION_SETTINGS_FIELD_NUMBER

public static final int EVENT_THREAT_DETECTION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int PROJECT_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_HEALTH_ANALYTICS_SETTINGS_FIELD_NUMBER

public static final int SECURITY_HEALTH_ANALYTICS_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WEB_SECURITY_SCANNER_SETTINGS_FIELD_NUMBER

public static final int WEB_SECURITY_SCANNER_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ComponentSettings getDefaultInstance()
Returns
Type Description
ComponentSettings

getDescriptor()

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

newBuilder()

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

newBuilder(ComponentSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsDetectorSettings(String key)

public boolean containsDetectorSettings(String key)

Settings for detectors. Not all detectors must have settings present at each and every level in the hierarchy. If it is not present the setting will be inherited from its ancestors folders, organizations or the defaults.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings> detector_settings = 4;

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

getContainerThreatDetectionSettings()

public ContainerThreatDetectionSettings getContainerThreatDetectionSettings()

Container Threate Detection specific settings For component, expect CONTAINER_THREAT_DETECTION

.google.cloud.securitycenter.settings.v1beta1.ContainerThreatDetectionSettings container_threat_detection_settings = 41;

Returns
Type Description
ContainerThreatDetectionSettings

The containerThreatDetectionSettings.

getContainerThreatDetectionSettingsOrBuilder()

public ContainerThreatDetectionSettingsOrBuilder getContainerThreatDetectionSettingsOrBuilder()

Container Threate Detection specific settings For component, expect CONTAINER_THREAT_DETECTION

.google.cloud.securitycenter.settings.v1beta1.ContainerThreatDetectionSettings container_threat_detection_settings = 41;

Returns
Type Description
ContainerThreatDetectionSettingsOrBuilder

getDefaultInstanceForType()

public ComponentSettings getDefaultInstanceForType()
Returns
Type Description
ComponentSettings

getDetectorSettings()

public Map<String,ComponentSettings.DetectorSettings> getDetectorSettings()

Use #getDetectorSettingsMap() instead.

Returns
Type Description
Map<String,DetectorSettings>

getDetectorSettingsCount()

public int getDetectorSettingsCount()

Settings for detectors. Not all detectors must have settings present at each and every level in the hierarchy. If it is not present the setting will be inherited from its ancestors folders, organizations or the defaults.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings> detector_settings = 4;

Returns
Type Description
int

getDetectorSettingsMap()

public Map<String,ComponentSettings.DetectorSettings> getDetectorSettingsMap()

Settings for detectors. Not all detectors must have settings present at each and every level in the hierarchy. If it is not present the setting will be inherited from its ancestors folders, organizations or the defaults.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings> detector_settings = 4;

Returns
Type Description
Map<String,DetectorSettings>

getDetectorSettingsOrDefault(String key, ComponentSettings.DetectorSettings defaultValue)

public ComponentSettings.DetectorSettings getDetectorSettingsOrDefault(String key, ComponentSettings.DetectorSettings defaultValue)

Settings for detectors. Not all detectors must have settings present at each and every level in the hierarchy. If it is not present the setting will be inherited from its ancestors folders, organizations or the defaults.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings> detector_settings = 4;

Parameters
Name Description
key String
defaultValue ComponentSettings.DetectorSettings
Returns
Type Description
ComponentSettings.DetectorSettings

getDetectorSettingsOrThrow(String key)

public ComponentSettings.DetectorSettings getDetectorSettingsOrThrow(String key)

Settings for detectors. Not all detectors must have settings present at each and every level in the hierarchy. If it is not present the setting will be inherited from its ancestors folders, organizations or the defaults.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings> detector_settings = 4;

Parameter
Name Description
key String
Returns
Type Description
ComponentSettings.DetectorSettings

getEtag()

public String getEtag()

Output only. An fingerprint used for optimistic concurrency. If none is provided on updates then the existing metadata will be blindly overwritten.

string etag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. An fingerprint used for optimistic concurrency. If none is provided on updates then the existing metadata will be blindly overwritten.

string etag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getEventThreatDetectionSettings()

public EventThreatDetectionSettings getEventThreatDetectionSettings()

Event Threat Detection specific settings For component, expect EVENT_THREAT_DETECTION

.google.cloud.securitycenter.settings.v1beta1.EventThreatDetectionSettings event_threat_detection_settings = 42;

Returns
Type Description
EventThreatDetectionSettings

The eventThreatDetectionSettings.

getEventThreatDetectionSettingsOrBuilder()

public EventThreatDetectionSettingsOrBuilder getEventThreatDetectionSettingsOrBuilder()

Event Threat Detection specific settings For component, expect EVENT_THREAT_DETECTION

.google.cloud.securitycenter.settings.v1beta1.EventThreatDetectionSettings event_threat_detection_settings = 42;

Returns
Type Description
EventThreatDetectionSettingsOrBuilder

getName()

public String getName()

The relative resource name of the component settings. Formats:

  • organizations/{organization}/components/{component}/settings
  • folders/{folder}/components/{component}/settings
  • projects/{project}/components/{component}/settings
  • projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings
  • projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings
  • projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The relative resource name of the component settings. Formats:

  • organizations/{organization}/components/{component}/settings
  • folders/{folder}/components/{component}/settings
  • projects/{project}/components/{component}/settings
  • projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings
  • projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings
  • projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProjectServiceAccount()

public String getProjectServiceAccount()

Output only. The service account to be used for security center component. The component must have permission to "act as" the service account.

string project_service_account = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The projectServiceAccount.

getProjectServiceAccountBytes()

public ByteString getProjectServiceAccountBytes()

Output only. The service account to be used for security center component. The component must have permission to "act as" the service account.

string project_service_account = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for projectServiceAccount.

getSecurityHealthAnalyticsSettings()

public SecurityHealthAnalyticsSettings getSecurityHealthAnalyticsSettings()

Security Health Analytics specific settings For component, expect SECURITY_HEALTH_ANALYTICS

.google.cloud.securitycenter.settings.v1beta1.SecurityHealthAnalyticsSettings security_health_analytics_settings = 44;

Returns
Type Description
SecurityHealthAnalyticsSettings

The securityHealthAnalyticsSettings.

getSecurityHealthAnalyticsSettingsOrBuilder()

public SecurityHealthAnalyticsSettingsOrBuilder getSecurityHealthAnalyticsSettingsOrBuilder()

Security Health Analytics specific settings For component, expect SECURITY_HEALTH_ANALYTICS

.google.cloud.securitycenter.settings.v1beta1.SecurityHealthAnalyticsSettings security_health_analytics_settings = 44;

Returns
Type Description
SecurityHealthAnalyticsSettingsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpecificSettingsCase()

public ComponentSettings.SpecificSettingsCase getSpecificSettingsCase()
Returns
Type Description
ComponentSettings.SpecificSettingsCase

getState()

public ComponentEnablementState getState()

ENABLE to enable component, DISABLE to disable and INHERIT to inherit setting from ancestors.

.google.cloud.securitycenter.settings.v1beta1.ComponentEnablementState state = 2;

Returns
Type Description
ComponentEnablementState

The state.

getStateValue()

public int getStateValue()

ENABLE to enable component, DISABLE to disable and INHERIT to inherit setting from ancestors.

.google.cloud.securitycenter.settings.v1beta1.ComponentEnablementState state = 2;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time these settings were last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time these settings were last updated.

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

Returns
Type Description
TimestampOrBuilder

getWebSecurityScannerSettings()

public WebSecurityScanner getWebSecurityScannerSettings()

Web Security Scanner specific settings For component, expect WEB_SECURITY_SCANNER

.google.cloud.securitycenter.settings.v1beta1.WebSecurityScanner web_security_scanner_settings = 40;

Returns
Type Description
WebSecurityScanner

The webSecurityScannerSettings.

getWebSecurityScannerSettingsOrBuilder()

public WebSecurityScannerOrBuilder getWebSecurityScannerSettingsOrBuilder()

Web Security Scanner specific settings For component, expect WEB_SECURITY_SCANNER

.google.cloud.securitycenter.settings.v1beta1.WebSecurityScanner web_security_scanner_settings = 40;

Returns
Type Description
WebSecurityScannerOrBuilder

hasContainerThreatDetectionSettings()

public boolean hasContainerThreatDetectionSettings()

Container Threate Detection specific settings For component, expect CONTAINER_THREAT_DETECTION

.google.cloud.securitycenter.settings.v1beta1.ContainerThreatDetectionSettings container_threat_detection_settings = 41;

Returns
Type Description
boolean

Whether the containerThreatDetectionSettings field is set.

hasEventThreatDetectionSettings()

public boolean hasEventThreatDetectionSettings()

Event Threat Detection specific settings For component, expect EVENT_THREAT_DETECTION

.google.cloud.securitycenter.settings.v1beta1.EventThreatDetectionSettings event_threat_detection_settings = 42;

Returns
Type Description
boolean

Whether the eventThreatDetectionSettings field is set.

hasSecurityHealthAnalyticsSettings()

public boolean hasSecurityHealthAnalyticsSettings()

Security Health Analytics specific settings For component, expect SECURITY_HEALTH_ANALYTICS

.google.cloud.securitycenter.settings.v1beta1.SecurityHealthAnalyticsSettings security_health_analytics_settings = 44;

Returns
Type Description
boolean

Whether the securityHealthAnalyticsSettings field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time these settings were last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hasWebSecurityScannerSettings()

public boolean hasWebSecurityScannerSettings()

Web Security Scanner specific settings For component, expect WEB_SECURITY_SCANNER

.google.cloud.securitycenter.settings.v1beta1.WebSecurityScanner web_security_scanner_settings = 40;

Returns
Type Description
boolean

Whether the webSecurityScannerSettings field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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