Class EventThreatDetectionCustomModule (0.13.0)

public final class EventThreatDetectionCustomModule extends GeneratedMessageV3 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

Inheritance

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

Static Fields

ANCESTOR_MODULE_FIELD_NUMBER

public static final int ANCESTOR_MODULE_FIELD_NUMBER
Field Value
Type Description
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLEMENT_STATE_FIELD_NUMBER

public static final int ENABLEMENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

LAST_EDITOR_FIELD_NUMBER

public static final int LAST_EDITOR_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_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 EventThreatDetectionCustomModule getDefaultInstance()
Returns
Type Description
EventThreatDetectionCustomModule

getDescriptor()

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

newBuilder()

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

newBuilder(EventThreatDetectionCustomModule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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