Class Settings (0.12.0) 

public final class Settings extends GeneratedMessageV3 implements SettingsOrBuilder

Common configuration settings for all of Security Center.

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

Inheritance

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

Implements

SettingsOrBuilder

Static Fields

BILLING_SETTINGS_FIELD_NUMBER

public static final int BILLING_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

COMPONENT_SETTINGS_FIELD_NUMBER

public static final int COMPONENT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DETECTOR_GROUP_SETTINGS_FIELD_NUMBER

public static final int DETECTOR_GROUP_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORG_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int ORG_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SINK_SETTINGS_FIELD_NUMBER

public static final int SINK_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

Static Methods

getDefaultInstance()

public static Settings getDefaultInstance()
Returns
Type Description
Settings

getDescriptor()

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

newBuilder()

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

newBuilder(Settings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsComponentSettings(String key)

public boolean containsComponentSettings(String key)

The settings for detectors and/or scanners.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings> component_settings = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsDetectorGroupSettings(String key)

public boolean containsDetectorGroupSettings(String key)

Detector group settings for all Security Center components. The key is the name of the detector group and the value is the settings for that group.

map<string, .google.cloud.securitycenter.settings.v1beta1.Settings.DetectorGroupSettings> detector_group_settings = 8;

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

getBillingSettings()

public BillingSettings getBillingSettings()

Billing settings

.google.cloud.securitycenter.settings.v1beta1.BillingSettings billing_settings = 2;

Returns
Type Description
BillingSettings

The billingSettings.

getBillingSettingsOrBuilder()

public BillingSettingsOrBuilder getBillingSettingsOrBuilder()

Billing settings

.google.cloud.securitycenter.settings.v1beta1.BillingSettings billing_settings = 2;

Returns
Type Description
BillingSettingsOrBuilder

getComponentSettings()

public Map<String,ComponentSettings> getComponentSettings()

Use #getComponentSettingsMap() instead.

Returns
Type Description
Map<String,ComponentSettings>

getComponentSettingsCount()

public int getComponentSettingsCount()

The settings for detectors and/or scanners.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings> component_settings = 7;

Returns
Type Description
int

getComponentSettingsMap()

public Map<String,ComponentSettings> getComponentSettingsMap()

The settings for detectors and/or scanners.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings> component_settings = 7;

Returns
Type Description
Map<String,ComponentSettings>

getComponentSettingsOrDefault(String key, ComponentSettings defaultValue)

public ComponentSettings getComponentSettingsOrDefault(String key, ComponentSettings defaultValue)

The settings for detectors and/or scanners.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings> component_settings = 7;

Parameters
Name Description
key String
defaultValue ComponentSettings
Returns
Type Description
ComponentSettings

getComponentSettingsOrThrow(String key)

public ComponentSettings getComponentSettingsOrThrow(String key)

The settings for detectors and/or scanners.

map<string, .google.cloud.securitycenter.settings.v1beta1.ComponentSettings> component_settings = 7;

Parameter
Name Description
key String
Returns
Type Description
ComponentSettings

getDefaultInstanceForType()

public Settings getDefaultInstanceForType()
Returns
Type Description
Settings

getDetectorGroupSettings()

public Map<String,Settings.DetectorGroupSettings> getDetectorGroupSettings()

Use #getDetectorGroupSettingsMap() instead.

Returns
Type Description
Map<String,DetectorGroupSettings>

getDetectorGroupSettingsCount()

public int getDetectorGroupSettingsCount()

Detector group settings for all Security Center components. The key is the name of the detector group and the value is the settings for that group.

map<string, .google.cloud.securitycenter.settings.v1beta1.Settings.DetectorGroupSettings> detector_group_settings = 8;

Returns
Type Description
int

getDetectorGroupSettingsMap()

public Map<String,Settings.DetectorGroupSettings> getDetectorGroupSettingsMap()

Detector group settings for all Security Center components. The key is the name of the detector group and the value is the settings for that group.

map<string, .google.cloud.securitycenter.settings.v1beta1.Settings.DetectorGroupSettings> detector_group_settings = 8;

Returns
Type Description
Map<String,DetectorGroupSettings>

getDetectorGroupSettingsOrDefault(String key, Settings.DetectorGroupSettings defaultValue)

public Settings.DetectorGroupSettings getDetectorGroupSettingsOrDefault(String key, Settings.DetectorGroupSettings defaultValue)

Detector group settings for all Security Center components. The key is the name of the detector group and the value is the settings for that group.

map<string, .google.cloud.securitycenter.settings.v1beta1.Settings.DetectorGroupSettings> detector_group_settings = 8;

Parameters
Name Description
key String
defaultValue Settings.DetectorGroupSettings
Returns
Type Description
Settings.DetectorGroupSettings

getDetectorGroupSettingsOrThrow(String key)

public Settings.DetectorGroupSettings getDetectorGroupSettingsOrThrow(String key)

Detector group settings for all Security Center components. The key is the name of the detector group and the value is the settings for that group.

map<string, .google.cloud.securitycenter.settings.v1beta1.Settings.DetectorGroupSettings> detector_group_settings = 8;

Parameter
Name Description
key String
Returns
Type Description
Settings.DetectorGroupSettings

getEtag()

public String getEtag()

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

string etag = 9;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 9;

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

The relative resource name of the settings resource. Formats:

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The relative resource name of the settings resource. Formats:

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOrgServiceAccount()

public String getOrgServiceAccount()

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

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

Returns
Type Description
String

The orgServiceAccount.

getOrgServiceAccountBytes()

public ByteString getOrgServiceAccountBytes()

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

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

Returns
Type Description
ByteString

The bytes for orgServiceAccount.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSinkSettings()

public SinkSettings getSinkSettings()

Sink settings.

.google.cloud.securitycenter.settings.v1beta1.SinkSettings sink_settings = 6;

Returns
Type Description
SinkSettings

The sinkSettings.

getSinkSettingsOrBuilder()

public SinkSettingsOrBuilder getSinkSettingsOrBuilder()

Sink settings.

.google.cloud.securitycenter.settings.v1beta1.SinkSettings sink_settings = 6;

Returns
Type Description
SinkSettingsOrBuilder

getState()

public Settings.OnboardingState getState()

An enum representing the current on boarding state of SCC.

.google.cloud.securitycenter.settings.v1beta1.Settings.OnboardingState state = 3;

Returns
Type Description
Settings.OnboardingState

The state.

getStateValue()

public int getStateValue()

An enum representing the current on boarding state of SCC.

.google.cloud.securitycenter.settings.v1beta1.Settings.OnboardingState state = 3;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time these settings were last updated.

.google.protobuf.Timestamp update_time = 10 [(.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 = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasBillingSettings()

public boolean hasBillingSettings()

Billing settings

.google.cloud.securitycenter.settings.v1beta1.BillingSettings billing_settings = 2;

Returns
Type Description
boolean

Whether the billingSettings field is set.

hasSinkSettings()

public boolean hasSinkSettings()

Sink settings.

.google.cloud.securitycenter.settings.v1beta1.SinkSettings sink_settings = 6;

Returns
Type Description
boolean

Whether the sinkSettings field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time these settings were last updated.

.google.protobuf.Timestamp update_time = 10 [(.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

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 Settings.Builder newBuilderForType()
Returns
Type Description
Settings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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