Class SecurityHealthAnalyticsCustomModule.Builder (2.51.0)

public static final class SecurityHealthAnalyticsCustomModule.Builder extends GeneratedMessageV3.Builder<SecurityHealthAnalyticsCustomModule.Builder> implements SecurityHealthAnalyticsCustomModuleOrBuilder

Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.

Protobuf type google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SecurityHealthAnalyticsCustomModule build()
Returns
Type Description
SecurityHealthAnalyticsCustomModule

buildPartial()

public SecurityHealthAnalyticsCustomModule buildPartial()
Returns
Type Description
SecurityHealthAnalyticsCustomModule

clear()

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

clearAncestorModule()

public SecurityHealthAnalyticsCustomModule.Builder clearAncestorModule()

Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.

string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearCustomConfig()

public SecurityHealthAnalyticsCustomModule.Builder clearCustomConfig()

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

clearDisplayName()

public SecurityHealthAnalyticsCustomModule.Builder clearDisplayName()

The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 2;

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearEnablementState()

public SecurityHealthAnalyticsCustomModule.Builder clearEnablementState()

The enablement state of the custom module.

.google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLastEditor()

public SecurityHealthAnalyticsCustomModule.Builder clearLastEditor()

Output only. The editor that last updated the custom module.

string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearName()

public SecurityHealthAnalyticsCustomModule.Builder clearName()

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

The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

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

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUpdateTime()

public SecurityHealthAnalyticsCustomModule.Builder clearUpdateTime()

Output only. The time at which the custom module was last updated.

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

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

clone()

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

getAncestorModule()

public String getAncestorModule()

Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.

string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The ancestorModule.

getAncestorModuleBytes()

public ByteString getAncestorModuleBytes()

Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.

string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for ancestorModule.

getCustomConfig()

public CustomConfig getCustomConfig()

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Returns
Type Description
CustomConfig

The customConfig.

getCustomConfigBuilder()

public CustomConfig.Builder getCustomConfigBuilder()

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Returns
Type Description
CustomConfig.Builder

getCustomConfigOrBuilder()

public CustomConfigOrBuilder getCustomConfigOrBuilder()

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Returns
Type Description
CustomConfigOrBuilder

getDefaultInstanceForType()

public SecurityHealthAnalyticsCustomModule getDefaultInstanceForType()
Returns
Type Description
SecurityHealthAnalyticsCustomModule

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEnablementState()

public SecurityHealthAnalyticsCustomModule.EnablementState getEnablementState()

The enablement state of the custom module.

.google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;

Returns
Type Description
SecurityHealthAnalyticsCustomModule.EnablementState

The enablementState.

getEnablementStateValue()

public int getEnablementStateValue()

The enablement state of the custom module.

.google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;

Returns
Type Description
int

The enum numeric value on the wire for enablementState.

getLastEditor()

public String getLastEditor()

Output only. The editor that last updated the custom module.

string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lastEditor.

getLastEditorBytes()

public ByteString getLastEditorBytes()

Output only. The editor that last updated the custom module.

string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lastEditor.

getName()

public String getName()

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

The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

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

Returns
Type Description
ByteString

The bytes for name.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which the custom module was last updated.

.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 at which the custom module was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which the custom module was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCustomConfig()

public boolean hasCustomConfig()

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Returns
Type Description
boolean

Whether the customConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which the custom module was last updated.

.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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomConfig(CustomConfig value)

public SecurityHealthAnalyticsCustomModule.Builder mergeCustomConfig(CustomConfig value)

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Parameter
Name Description
value CustomConfig
Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

mergeFrom(SecurityHealthAnalyticsCustomModule other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public SecurityHealthAnalyticsCustomModule.Builder mergeUpdateTime(Timestamp value)

Output only. The time at which the custom module was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

setAncestorModule(String value)

public SecurityHealthAnalyticsCustomModule.Builder setAncestorModule(String value)

Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.

string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The ancestorModule to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setAncestorModuleBytes(ByteString value)

public SecurityHealthAnalyticsCustomModule.Builder setAncestorModuleBytes(ByteString value)

Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.

string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for ancestorModule to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setCustomConfig(CustomConfig value)

public SecurityHealthAnalyticsCustomModule.Builder setCustomConfig(CustomConfig value)

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Parameter
Name Description
value CustomConfig
Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

setCustomConfig(CustomConfig.Builder builderForValue)

public SecurityHealthAnalyticsCustomModule.Builder setCustomConfig(CustomConfig.Builder builderForValue)

The user specified custom configuration for the module.

.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;

Parameter
Name Description
builderForValue CustomConfig.Builder
Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

setDisplayName(String value)

public SecurityHealthAnalyticsCustomModule.Builder setDisplayName(String value)

The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public SecurityHealthAnalyticsCustomModule.Builder setDisplayNameBytes(ByteString value)

The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

string display_name = 2;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setEnablementState(SecurityHealthAnalyticsCustomModule.EnablementState value)

public SecurityHealthAnalyticsCustomModule.Builder setEnablementState(SecurityHealthAnalyticsCustomModule.EnablementState value)

The enablement state of the custom module.

.google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;

Parameter
Name Description
value SecurityHealthAnalyticsCustomModule.EnablementState

The enablementState to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setEnablementStateValue(int value)

public SecurityHealthAnalyticsCustomModule.Builder setEnablementStateValue(int value)

The enablement state of the custom module.

.google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4;

Parameter
Name Description
value int

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

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setLastEditor(String value)

public SecurityHealthAnalyticsCustomModule.Builder setLastEditor(String value)

Output only. The editor that last updated the custom module.

string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The lastEditor to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setLastEditorBytes(ByteString value)

public SecurityHealthAnalyticsCustomModule.Builder setLastEditorBytes(ByteString value)

Output only. The editor that last updated the custom module.

string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for lastEditor to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setName(String value)

public SecurityHealthAnalyticsCustomModule.Builder setName(String value)

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

The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SecurityHealthAnalyticsCustomModule.Builder setNameBytes(ByteString value)

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

The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public SecurityHealthAnalyticsCustomModule.Builder setUpdateTime(Timestamp value)

Output only. The time at which the custom module was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public SecurityHealthAnalyticsCustomModule.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which the custom module was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SecurityHealthAnalyticsCustomModule.Builder