Package com.oracle.bmc.cloudguard.model

Class SecurityZone

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200131")
public final class SecurityZone
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe.

    Any actions in the zone’s compartment (and any subcompartments in the zone) that violate a policy are denied.
    Note: Objects should always be created or deserialized using the SecurityZone.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 SecurityZone.Builder, which maintain a set of all explicitly set fields called SecurityZone.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

      • getDisplayName

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

      • getDescription

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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment for the security zone
        Returns:
        the value

      • getSecurityZoneRecipeId

        public String getSecurityZoneRecipeId()
        The OCID of the recipe (SecurityRecipe resource) for the security zone
        Returns:
        the value

      • getSecurityZoneTargetId

        public String getSecurityZoneTargetId()
        The OCID of the target associated with the security zone
        Returns:
        the value

      • getInheritedByCompartments

        public List<String> getInheritedByCompartments()
        List of inherited compartments
        Returns:
        the value

      • getTimeCreated

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

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

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

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current lifecycle state of the security zone
        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 zone in the 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