Package com.oracle.bmc.apiaccesscontrol.model

Class ApiMetadata

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public final class ApiMetadata
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An ApiDetail contains details such as the service it belongs to, the name of the api, the type of api, and the parameters of the api if it contains.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the ApiMetadata.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 ApiMetadata.Builder, which maintain a set of all explicitly set fields called ApiMetadata.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()
        The OCID of the ApiDetail.
        Returns:
        the value

      • getServiceName

        public String getServiceName()
        The service Name to which the api belongs to.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The operation Name of the api.

        The name must be unique.

        Returns:
        the value

      • getPath

        public String getPath()
        rest path of the api.
        Returns:
        the value

      • getEntityType

        public String getEntityType()
        ResourceType to which the apiMetadata belongs to.
        Returns:
        the value

      • getApiName

        public String getApiName()
        The name of the api to execute the api request.
        Returns:
        the value

      • getFields

        public List<String> getFields()
        List of the fields that is use while calling post or put for the data.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339.

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

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339.

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

        Returns:
        the value

      • getTimeDeleted

        public Date getTimeDeleted()
        The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.

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

        Returns:
        the value

      • getLifecycleState

        public ApiMetadata.LifecycleState getLifecycleState()
        The current state of the ApiMetadata.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the ApiMetadata in more detail.

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

        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

      • getSystemTags

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

        Each key is predefined and scoped to a namespace.

        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