com.oracle.bmc.cloudguard.model

Class ResponderRecipe

java.lang.Object

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

com.oracle.bmc.cloudguard.model.ResponderRecipe

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

A ResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat).

A ResponderRecipe resource: * Is effectively a copy of a Responder resource in which users can make very limited changes if it’s Oracle-managed, and more changes if it’s user-managed. * Can also be created by cloning an existing ResponderRecipe resource, either user-managed or Oracle-managed. * Is visible on Cloud Guard’s Responder Recipes page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply globally, to resources in all OCI compartments mapped to a target that attaches the responder recipe, but are overridden by any changes made in the corresponding TargetResponderRecipe resource (effectively created when the responder recipe is attached to the target).
Note: Objects should always be created or deserialized using the ResponderRecipe.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 ResponderRecipe.Builder, which maintain a set of all explicitly set fields called ResponderRecipe.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 and Description
static class	ResponderRecipe.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 and Description

ResponderRecipe(String id, String displayName, String description, OwnerType owner, List<ResponderRecipeResponderRule> responderRules, List<ResponderRecipeResponderRule> effectiveResponderRules, String sourceResponderRecipeId, String compartmentId, Date timeCreated, Date timeUpdated, LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ResponderRecipe.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() Compartment OCID
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDescription() Responder recipe description
String	getDisplayName() Responder recipe display name
List<ResponderRecipeResponderRule>	getEffectiveResponderRules() List of currently enabled responder rules for the responder type, for recipe after applying defaults
Map<String,String>	getFreeformTags() Simple key-value pair that is applied without any predefined name, type or scope.
String	getId() Unique identifier for the responder recip
String	getLifecycleDetails() A message describing the current state in more detail.
LifecycleState	getLifecycleState() The current lifecycle state of the example
OwnerType	getOwner() Owner of responder recipe
List<ResponderRecipeResponderRule>	getResponderRules() List of responder rules associated with the recipe
String	getSourceResponderRecipeId() The unique identifier of the source responder recipe
Map<String,Map<String,Object>>	getSystemTags() System tags for this resource.
Date	getTimeCreated() The date and time the responder recipe was created.
Date	getTimeUpdated() The date and time the responder recipe was last updated.
int	hashCode()
ResponderRecipe.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

ResponderRecipe

@Deprecated
 @ConstructorProperties(value={"id","displayName","description","owner","responderRules","effectiveResponderRules","sourceResponderRecipeId","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"})
public ResponderRecipe(String id,
                                                                                                                                                                                                                                                                                                            String displayName,
                                                                                                                                                                                                                                                                                                            String description,
                                                                                                                                                                                                                                                                                                            OwnerType owner,
                                                                                                                                                                                                                                                                                                            List<ResponderRecipeResponderRule> responderRules,
                                                                                                                                                                                                                                                                                                            List<ResponderRecipeResponderRule> effectiveResponderRules,
                                                                                                                                                                                                                                                                                                            String sourceResponderRecipeId,
                                                                                                                                                                                                                                                                                                            String compartmentId,
                                                                                                                                                                                                                                                                                                            Date timeCreated,
                                                                                                                                                                                                                                                                                                            Date timeUpdated,
                                                                                                                                                                                                                                                                                                            LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                            String lifecycleDetails,
                                                                                                                                                                                                                                                                                                            Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                            Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                            Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static ResponderRecipe.Builder builder()

Create a new builder.

toBuilder

public ResponderRecipe.Builder toBuilder()

getId

public String getId()

Unique identifier for the responder recip

Returns:

the value

getDisplayName

public String getDisplayName()

Responder recipe display name

Returns:

the value

getDescription

public String getDescription()

Responder recipe description

Returns:

the value

getOwner

public OwnerType getOwner()

Owner of responder recipe

Returns:

the value

getResponderRules

public List<ResponderRecipeResponderRule> getResponderRules()

List of responder rules associated with the recipe

Returns:

the value

getEffectiveResponderRules

public List<ResponderRecipeResponderRule> getEffectiveResponderRules()

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

Returns:

the value

getSourceResponderRecipeId

public String getSourceResponderRecipeId()

The unique identifier of the source responder recipe

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment OCID

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the responder recipe was created. Format defined by RFC3339.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the responder recipe was last updated. Format defined by RFC3339.

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

The current lifecycle state of the example

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

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