Package com.oracle.bmc.cloudguard.model

Class TargetDetectorRecipe

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.cloudguard.model.TargetDetectorRecipe

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200131")
public final class TargetDetectorRecipe
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A TargetDetectorRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which some settings can be modified specifically for a single target.

A TargetDetectorRecipe resource: * Is effectively a copy of a DetectorRecipe resource in which users can make very limited changes if it\u2019s Oracle-managed, and more changes if it\u2019s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here override any settings in the corresponding DetectorRecipe, of which the TargetDetectorRecipe resource is effectively a copy, created when the detector recipe is attached to the target.
Note: Objects should always be created or deserialized using the TargetDetectorRecipe.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the TargetDetectorRecipe.Builder, which maintain a set of all explicitly set fields called TargetDetectorRecipe.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TargetDetectorRecipe.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

TargetDetectorRecipe(String id, String displayName, String description, String compartmentId, String detectorRecipeId, OwnerType owner, DetectorEnum detector, List<TargetDetectorRecipeDetectorRule> detectorRules, List<TargetDetectorRecipeDetectorRule> effectiveDetectorRules, Date timeCreated, Date timeUpdated, LifecycleState lifecycleState, List<ResourceLock> locks, DetectorRecipeEnum detectorRecipeType, Integer sourceDataRetention)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static TargetDetectorRecipe.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	Compartment OCID of the detector recipe
String	getDescription()	Detector recipe description.
DetectorEnum	getDetector()	Type of detector
String	getDetectorRecipeId()	Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based
DetectorRecipeEnum	getDetectorRecipeType()	Recipe type ( STANDARD, ENTERPRISE )
List<TargetDetectorRecipeDetectorRule>	getDetectorRules()	List of detector rules for the detector recipe - user input
String	getDisplayName()	Display name of the detector recipe
List<TargetDetectorRecipeDetectorRule>	getEffectiveDetectorRules()	List of currently enabled detector rules for the detector type for recipe after applying defaults
String	getId()	OCID for the detector recipe
LifecycleState	getLifecycleState()	The current lifecycle state of the resource
List<ResourceLock>	getLocks()	Locks associated with this resource.
OwnerType	getOwner()	Owner of the detector recipe
Integer	getSourceDataRetention()	The number of days for which source data is retained
Date	getTimeCreated()	The date and time the target detector recipe was created.
Date	getTimeUpdated()	The date and time the target detector recipe was last updated.
int	hashCode()
TargetDetectorRecipe.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TargetDetectorRecipe

@Deprecated
@ConstructorProperties({"id","displayName","description","compartmentId","detectorRecipeId","owner","detector","detectorRules","effectiveDetectorRules","timeCreated","timeUpdated","lifecycleState","locks","detectorRecipeType","sourceDataRetention"})
public TargetDetectorRecipe(String id,
                            String displayName,
                            String description,
                            String compartmentId,
                            String detectorRecipeId,
                            OwnerType owner,
                            DetectorEnum detector,
                            List<TargetDetectorRecipeDetectorRule> detectorRules,
                            List<TargetDetectorRecipeDetectorRule> effectiveDetectorRules,
                            Date timeCreated,
                            Date timeUpdated,
                            LifecycleState lifecycleState,
                            List<ResourceLock> locks,
                            DetectorRecipeEnum detectorRecipeType,
                            Integer sourceDataRetention)

Deprecated.

Method Detail

builder

public static TargetDetectorRecipe.Builder builder()

Create a new builder.

toBuilder

public TargetDetectorRecipe.Builder toBuilder()

getId

public String getId()

OCID for the detector recipe

Returns:

the value

getDisplayName

public String getDisplayName()

Display name of the detector recipe

Returns:

the value

getDescription

public String getDescription()

Detector recipe description.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment OCID of the detector recipe

Returns:

the value

getDetectorRecipeId

public String getDetectorRecipeId()

Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based

Returns:

the value

getOwner

public OwnerType getOwner()

Owner of the detector recipe

Returns:

the value

getDetector

public DetectorEnum getDetector()

Type of detector

Returns:

the value

getDetectorRules

public List<TargetDetectorRecipeDetectorRule> getDetectorRules()

List of detector rules for the detector recipe - user input

Returns:

the value

getEffectiveDetectorRules

public List<TargetDetectorRecipeDetectorRule> getEffectiveDetectorRules()

List of currently enabled detector rules for the detector type for recipe after applying defaults

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the target detector recipe was created.

Format defined by RFC3339.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the target detector recipe was last updated.

Format defined by RFC3339.

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

The current lifecycle state of the resource

Returns:

the value

getLocks

public List<ResourceLock> getLocks()

Locks associated with this resource.

Returns:

the value

getDetectorRecipeType

public DetectorRecipeEnum getDetectorRecipeType()

Recipe type ( STANDARD, ENTERPRISE )

Returns:

the value

getSourceDataRetention

public Integer getSourceDataRetention()

The number of days for which source data is retained

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel