Package com.oracle.bmc.cloudguard.model

Class DetectorRecipe

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200131")
public final class DetectorRecipe
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A detector recipe is a collection of rules that can be configured to trigger problems that appear on the Cloud Guard Problems page.

    A DetectorRecipe resource contains settings for a specific detector recipe, plus a list of the detector rules (DetectorRecipeDetectorRule resources) belonging to the DetectorRecipe resource.
    Note: Objects should always be created or deserialized using the DetectorRecipe.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 DetectorRecipe.Builder, which maintain a set of all explicitly set fields called DetectorRecipe.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).

    • Method Detail

      • getId

        public String getId()
        OCID for detector recipe
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Display name of detector recipe
        Returns:
        the value

      • getDescription

        public String getDescription()
        Detector recipe description
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Compartment OCID of detector recipe
        Returns:
        the value

      • getSourceDetectorRecipeId

        public String getSourceDetectorRecipeId()
        Recipe OCID of the source recipe to be cloned
        Returns:
        the value

      • getDetectorRecipeType

        public DetectorRecipeEnum getDetectorRecipeType()
        Recipe type ( STANDARD, ENTERPRISE )
        Returns:
        the value

      • getOwner

        public OwnerType getOwner()
        Owner of detector recipe
        Returns:
        the value

      • getDetector

        public DetectorEnum getDetector()
        Type of detector
        Returns:
        the value

      • getDetectorRules

        public List<DetectorRecipeDetectorRule> getDetectorRules()
        List of detector rules for the detector type for recipe - user input
        Returns:
        the value

      • getEffectiveDetectorRules

        public List<DetectorRecipeDetectorRule> getEffectiveDetectorRules()
        List of effective detector rules for the detector type for recipe after applying defaults
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the detector recipe was created Format defined by RFC3339.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the 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

      • getSourceDataRetention

        public Integer getSourceDataRetention()
        The number of days for which source data is retained
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Avoid entering confidential information.

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • getTargetIds

        public List<String> getTargetIds()
        List of target IDs to which the recipe is attached
        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