Interface SecurityHealthAnalyticsCustomModuleOrBuilder (2.55.0)

public interface SecurityHealthAnalyticsCustomModuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAncestorModule()

public abstract 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 abstract 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 abstract 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 abstract CustomConfigOrBuilder getCustomConfigOrBuilder()

The user specified custom configuration for the module.

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

Returns
Type Description
CustomConfigOrBuilder

getDisplayName()

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