Package com.oracle.bmc.cloudguard.model

Class SecurityPolicy

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200131")
public final class SecurityPolicy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A security policy (SecurityPolicy resource) defines security requirements for resources in a security zone.

    If a security zone enables a security policy through a security recipe (SecurityRecipe resource), then any action that would violate that policy is blocked.
    Note: Objects should always be created or deserialized using the SecurityPolicy.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 SecurityPolicy.Builder, which maintain a set of all explicitly set fields called SecurityPolicy.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()
        Unique identifier that can\u2019t be changed after creation
        Returns:
        the value

      • getFriendlyName

        public String getFriendlyName()
        A shorter version of the security policy’s name
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The security policy’s display name
        Returns:
        the value

      • getDescription

        public String getDescription()
        The security policy’s description
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the security policy’s compartment
        Returns:
        the value

      • getOwner

        public OwnerType getOwner()
        The owner of the security policy
        Returns:
        the value

      • getCategory

        public String getCategory()
        The category of the security policy
        Returns:
        the value

      • getServices

        public List<String> getServices()
        The list of services that the security policy protects
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the security policy was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the security policy was last updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current lifecycle state of the security policy
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail.

        For example, this can be used to provide actionable information for a resource in a Failed state.

        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        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