Class SecurityHealthAnalyticsCustomModule (2.54.0)

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

Inheritance

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

Static Fields

ANCESTOR_MODULE_FIELD_NUMBER

public static final int ANCESTOR_MODULE_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_CONFIG_FIELD_NUMBER

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

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecurityHealthAnalyticsCustomModule getDefaultInstance()
Returns
Type Description
SecurityHealthAnalyticsCustomModule

getDescriptor()

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

newBuilder()

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

newBuilder(SecurityHealthAnalyticsCustomModule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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. 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.

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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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