Package com.oracle.bmc.generativeaiagent.model

Class DataSource

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class DataSource
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A data source points to the source of your data.

    After you add a data source to a knowledge base, you must ingest the data source’s data, so that agents using the knowledge base can refer to the data.

    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 DataSource.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 DataSource.Builder, which maintain a set of all explicitly set fields called DataSource.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 data source.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

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

        Returns:
        the value

      • getDescription

        public String getDescription()
        A description of the data source.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getKnowledgeBaseId

        public String getKnowledgeBaseId()
        The OCID of the parent KnowledgeBase.
        Returns:
        the value

      • getMetadata

        public Map<String,​String> getMetadata()
        Key-value pairs to allow additional configurations.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the data source 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 data source was updated, in the format defined by RFC 3339.

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

        Returns:
        the value

      • getLifecycleState

        public DataSource.LifecycleState getLifecycleState()
        The current state of the data source.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the data source 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