Package com.oracle.bmc.identity.model

Class Policy

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Policy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A document that specifies the type of access a group has to the resources in a compartment.

    For information about policies and other IAM Service components, see Overview of IAM. If you’re new to policies, see Get Started with Policies.

    The word "policy" is used by people in different ways:

    An individual statement written in the policy language * A collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it) * The overall body of policies your organization uses to control access to resources

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.

    *Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    Note: Objects should always be created or deserialized using the Policy.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 Policy.Builder, which maintain a set of all explicitly set fields called Policy.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

      • builder

        public static Policy.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The OCID of the policy.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the policy (either the tenancy or another compartment).
        Returns:
        the value

      • getName

        public String getName()
        The name you assign to the policy during creation.

        The name must be unique across all policies in the tenancy and cannot be changed.

        Returns:
        the value

      • getStatements

        public List<String> getStatements()
        An array of one or more policy statements written in the policy language.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description you assign to the policy.

        Does not have to be unique, and it’s changeable.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the policy was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        public Policy.LifecycleState getLifecycleState()
        The policy’s current state.

        After creating a policy, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

        Returns:
        the value

      • getInactiveStatus

        public Long getInactiveStatus()
        The detailed status of INACTIVE lifecycleState.
        Returns:
        the value

      • getVersionDate

        public Date getVersionDate()
        The version of the policy.

        If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

        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. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        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