Package com.oracle.bmc.generativeai.model

Class VectorStoreConnector

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class VectorStoreConnector
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A VectorStore Connector offers a lightweight and configurable mechanism to continuously synchronize data from external systems into the VectorStore at scale.

    It captures the configuration of the datasource for data ingestion.
    Note: Objects should always be created or deserialized using the VectorStoreConnector.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 VectorStoreConnector.Builder, which maintain a set of all explicitly set fields called VectorStoreConnector.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()
        An OCID that uniquely identifies a VectorStoreConnector
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name
        Returns:
        the value

      • getDescription

        public String getDescription()
        An optional description of the VectorStoreConnector
        Returns:
        the value

      • getVectorStoreId

        public String getVectorStoreId()
        An OCID that identifies the Vector Store to which this connector is connected.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Owning compartment OCID for a VectorStoreConnector.
        Returns:
        the value

      • getTenantId

        public String getTenantId()
        Owning tenant OCID for a VectorStoreConnector
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time that the VectorStoreConnector was created in the format of an RFC3339 datetime string.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string.
        Returns:
        the value

      • getVaultSecretId

        public String getVaultSecretId()
        An optional customer Encryption Key stored in OCI Vault that can be used to decrypt the data downloaded from the data source.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail that can provide actionable information.
        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