Class OracleNosqlConnectionSummary


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200407")
    public final class OracleNosqlConnectionSummary
    extends ConnectionSummary
    Summary of the Oracle NoSQL Connection.
    Note: Objects should always be created or deserialized using the OracleNosqlConnectionSummary.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 OracleNosqlConnectionSummary.Builder, which maintain a set of all explicitly set fields called OracleNosqlConnectionSummary.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

      • getTenancyId

        public String getTenancyId()
        The OCID of the related OCI tenancy.
        Returns:
        the value
      • getRegion

        public String getRegion()
        The name of the region.

        e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

        Returns:
        the value
      • getUserId

        public String getUserId()
        The OCID of the OCI user who will access the Oracle NoSQL database.

        The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.

        Returns:
        the value
      • getPrivateKeyFileSecretId

        public String getPrivateKeyFileSecretId()
        The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.

        See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, ‘privateKeyFile’ field must not be provided.

        Returns:
        the value
      • getPrivateKeyPassphraseSecretId

        public String getPrivateKeyPassphraseSecretId()
        The OCID of the Secret that stores the passphrase of the private key.

        Note: When provided, ‘privateKeyPassphrase’ field must not be provided.

        Returns:
        the value
      • getShouldUseResourcePrincipal

        public Boolean getShouldUseResourcePrincipal()
        Indicates that the user intents to connect to the instance through resource principal.
        Returns:
        the value
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class ConnectionSummary
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation