Package com.oracle.bmc.databasetools.model

Class DatabaseToolsSqlReport

  • Direct Known Subclasses:
    DatabaseToolsSqlReportOracleDatabase
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20201005")
public class DatabaseToolsSqlReport
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Allows generating a summary of SQL query execution details for database operations.
    Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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 Database Tools SQL report.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the Database Tools SQL report.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique and can be updated. Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        A description of the SQL report.
        Returns:
        the value

      • getSource

        public String getSource()
        SQL query executed to generate the report.
        Returns:
        the value

      • getPurpose

        public String getPurpose()
        Purpose of the Database Tools SQL report.

        Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.

        Returns:
        the value

      • getInstructions

        public String getInstructions()
        Instructions on how to use the SQL report.

        Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.

        Returns:
        the value

      • getColumns

        public List<DatabaseToolsSqlReportColumn> getColumns()
        Descriptive information on columns referenced in the Database Tools SQL Report source.
        Returns:
        the value

      • getLifecycleDetails

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

      • getTimeCreated

        public Date getTimeCreated()
        The time the Database Tools SQL report was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the Database Tools SQL report was updated.

        An RFC3339 formatted datetime string.

        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

      • 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”}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value

      • getLocks

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