Class EventThreatDetectionCustomModule.Builder (0.13.0)

public static final class EventThreatDetectionCustomModule.Builder extends GeneratedMessageV3.Builder<EventThreatDetectionCustomModule.Builder> implements EventThreatDetectionCustomModuleOrBuilder

An event threat detection custom module is a Cloud SCC resource that contains the configuration and enablement state of a custom module, which enables ETD to write certain findings to Cloud SCC.

Protobuf type google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public EventThreatDetectionCustomModule build()
Returns
Type Description
EventThreatDetectionCustomModule

buildPartial()

public EventThreatDetectionCustomModule buildPartial()
Returns
Type Description
EventThreatDetectionCustomModule

clear()

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

clearAncestorModule()

public EventThreatDetectionCustomModule.Builder clearAncestorModule()

Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule resource name.

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

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearConfig()

public EventThreatDetectionCustomModule.Builder clearConfig()

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventThreatDetectionCustomModule.Builder

clearDescription()

public EventThreatDetectionCustomModule.Builder clearDescription()

Optional. The description for the module.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearDisplayName()

public EventThreatDetectionCustomModule.Builder clearDisplayName()

Optional. The human readable name to be displayed for the module.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearEnablementState()

public EventThreatDetectionCustomModule.Builder clearEnablementState()

Optional. The state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLastEditor()

public EventThreatDetectionCustomModule.Builder clearLastEditor()

Output only. The editor the module was last updated by.

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

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearName()

public EventThreatDetectionCustomModule.Builder clearName()

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.

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

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearType()

public EventThreatDetectionCustomModule.Builder clearType()

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

clearUpdateTime()

public EventThreatDetectionCustomModule.Builder clearUpdateTime()

Output only. The time the module was last updated.

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

Returns
Type Description
EventThreatDetectionCustomModule.Builder

clone()

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

getAncestorModule()

public String getAncestorModule()

Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule resource name.

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

Returns
Type Description
String

The ancestorModule.

getAncestorModuleBytes()

public ByteString getAncestorModuleBytes()

Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule resource name.

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

Returns
Type Description
ByteString

The bytes for ancestorModule.

getConfig()

public Struct getConfig()

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The config.

getConfigBuilder()

public Struct.Builder getConfigBuilder()

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getConfigOrBuilder()

public StructOrBuilder getConfigOrBuilder()

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public EventThreatDetectionCustomModule getDefaultInstanceForType()
Returns
Type Description
EventThreatDetectionCustomModule

getDescription()

public String getDescription()

Optional. The description for the module.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description for the module.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. The human readable name to be displayed for the module.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The human readable name to be displayed for the module.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEnablementState()

public EventThreatDetectionCustomModule.EnablementState getEnablementState()

Optional. The state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventThreatDetectionCustomModule.EnablementState

The enablementState.

getEnablementStateValue()

public int getEnablementStateValue()

Optional. The state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for enablementState.

getLastEditor()

public String getLastEditor()

Output only. The editor the module was last updated by.

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

Returns
Type Description
String

The lastEditor.

getLastEditorBytes()

public ByteString getLastEditorBytes()

Output only. The editor the module was last updated by.

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

Returns
Type Description
ByteString

The bytes for lastEditor.

getName()

public String getName()

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.

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

Returns
Type Description
ByteString

The bytes for name.

getType()

public String getType()

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for type.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the module was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time the module was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the module was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasConfig()

public boolean hasConfig()

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the config field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the module was last updated.

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

mergeConfig(Struct value)

public EventThreatDetectionCustomModule.Builder mergeConfig(Struct value)

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
EventThreatDetectionCustomModule.Builder

mergeFrom(EventThreatDetectionCustomModule other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public EventThreatDetectionCustomModule.Builder mergeUpdateTime(Timestamp value)

Output only. The time the module was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EventThreatDetectionCustomModule.Builder

setAncestorModule(String value)

public EventThreatDetectionCustomModule.Builder setAncestorModule(String value)

Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule resource name.

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

Parameter
Name Description
value String

The ancestorModule to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setAncestorModuleBytes(ByteString value)

public EventThreatDetectionCustomModule.Builder setAncestorModuleBytes(ByteString value)

Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule resource name.

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

Parameter
Name Description
value ByteString

The bytes for ancestorModule to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setConfig(Struct value)

public EventThreatDetectionCustomModule.Builder setConfig(Struct value)

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
EventThreatDetectionCustomModule.Builder

setConfig(Struct.Builder builderForValue)

public EventThreatDetectionCustomModule.Builder setConfig(Struct.Builder builderForValue)

Optional. Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.

.google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EventThreatDetectionCustomModule.Builder

setDescription(String value)

public EventThreatDetectionCustomModule.Builder setDescription(String value)

Optional. The description for the module.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public EventThreatDetectionCustomModule.Builder setDescriptionBytes(ByteString value)

Optional. The description for the module.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setDisplayName(String value)

public EventThreatDetectionCustomModule.Builder setDisplayName(String value)

Optional. The human readable name to be displayed for the module.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public EventThreatDetectionCustomModule.Builder setDisplayNameBytes(ByteString value)

Optional. The human readable name to be displayed for the module.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setEnablementState(EventThreatDetectionCustomModule.EnablementState value)

public EventThreatDetectionCustomModule.Builder setEnablementState(EventThreatDetectionCustomModule.EnablementState value)

Optional. The state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EventThreatDetectionCustomModule.EnablementState

The enablementState to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setEnablementStateValue(int value)

public EventThreatDetectionCustomModule.Builder setEnablementStateValue(int value)

Optional. The state of enablement for the module at the given level of the hierarchy.

.google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setLastEditor(String value)

public EventThreatDetectionCustomModule.Builder setLastEditor(String value)

Output only. The editor the module was last updated by.

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

Parameter
Name Description
value String

The lastEditor to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setLastEditorBytes(ByteString value)

public EventThreatDetectionCustomModule.Builder setLastEditorBytes(ByteString value)

Output only. The editor the module was last updated by.

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

Parameter
Name Description
value ByteString

The bytes for lastEditor to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setName(String value)

public EventThreatDetectionCustomModule.Builder setName(String value)

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EventThreatDetectionCustomModule.Builder setNameBytes(ByteString value)

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

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

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

setType(String value)

public EventThreatDetectionCustomModule.Builder setType(String value)

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The type to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public EventThreatDetectionCustomModule.Builder setTypeBytes(ByteString value)

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for type to set.

Returns
Type Description
EventThreatDetectionCustomModule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public EventThreatDetectionCustomModule.Builder setUpdateTime(Timestamp value)

Output only. The time the module was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EventThreatDetectionCustomModule.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public EventThreatDetectionCustomModule.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time the module was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EventThreatDetectionCustomModule.Builder