Class EffectiveSecurityHealthAnalyticsCustomModule.Builder (2.37.0)

public static final class EffectiveSecurityHealthAnalyticsCustomModule.Builder extends GeneratedMessageV3.Builder<EffectiveSecurityHealthAnalyticsCustomModule.Builder> implements EffectiveSecurityHealthAnalyticsCustomModuleOrBuilder

An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablementState property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of INHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also enabled. EffectiveSecurityHealthAnalyticsCustomModule is read-only.

Protobuf type google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

build()

public EffectiveSecurityHealthAnalyticsCustomModule build()
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule

buildPartial()

public EffectiveSecurityHealthAnalyticsCustomModule buildPartial()
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule

clear()

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clear()
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

clearCustomConfig()

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clearCustomConfig()

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

clearDisplayName()

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clearDisplayName()

Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearEnablementState()

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clearEnablementState()

Output only. The effective state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

clearName()

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clearName()

Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

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

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

clone()

public EffectiveSecurityHealthAnalyticsCustomModule.Builder clone()
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

getCustomConfig()

public CustomConfig getCustomConfig()

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CustomConfig

The customConfig.

getCustomConfigBuilder()

public CustomConfig.Builder getCustomConfigBuilder()

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CustomConfig.Builder

getCustomConfigOrBuilder()

public CustomConfigOrBuilder getCustomConfigOrBuilder()

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CustomConfigOrBuilder

getDefaultInstanceForType()

public EffectiveSecurityHealthAnalyticsCustomModule getDefaultInstanceForType()
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for displayName.

getEnablementState()

public EffectiveSecurityHealthAnalyticsCustomModule.EnablementState getEnablementState()

Output only. The effective state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.EnablementState

The enablementState.

getEnablementStateValue()

public int getEnablementStateValue()

Output only. The effective state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for enablementState.

getName()

public String getName()

Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

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

Returns
TypeDescription
ByteString

The bytes for name.

hasCustomConfig()

public boolean hasCustomConfig()

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the customConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCustomConfig(CustomConfig value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder mergeCustomConfig(CustomConfig value)

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueCustomConfig
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

mergeFrom(EffectiveSecurityHealthAnalyticsCustomModule other)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder mergeFrom(EffectiveSecurityHealthAnalyticsCustomModule other)
Parameter
NameDescription
otherEffectiveSecurityHealthAnalyticsCustomModule
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EffectiveSecurityHealthAnalyticsCustomModule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

setCustomConfig(CustomConfig value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setCustomConfig(CustomConfig value)

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueCustomConfig
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

setCustomConfig(CustomConfig.Builder builderForValue)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setCustomConfig(CustomConfig.Builder builderForValue)

Output only. The user-specified configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueCustomConfig.Builder
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

setDisplayName(String value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setDisplayName(String value)

Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setDisplayNameBytes(ByteString value)

Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setEnablementState(EffectiveSecurityHealthAnalyticsCustomModule.EnablementState value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setEnablementState(EffectiveSecurityHealthAnalyticsCustomModule.EnablementState value)

Output only. The effective state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueEffectiveSecurityHealthAnalyticsCustomModule.EnablementState

The enablementState to set.

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setEnablementStateValue(int value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setEnablementStateValue(int value)

Output only. The effective state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

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

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

setName(String value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setName(String value)

Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setNameBytes(ByteString value)

Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

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

public EffectiveSecurityHealthAnalyticsCustomModule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final EffectiveSecurityHealthAnalyticsCustomModule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EffectiveSecurityHealthAnalyticsCustomModule.Builder
Overrides