Package com.oracle.bmc.datacatalog.model

Class CreateConnectionDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class CreateConnectionDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Properties used in connection create operations.
    Note: Objects should always be created or deserialized using the CreateConnectionDetails.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 CreateConnectionDetails.Builder, which maintain a set of all explicitly set fields called CreateConnectionDetails.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

      • getDescription

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

      • getDisplayName

        public String getDisplayName()
        A user-friendly display name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getTypeKey

        public String getTypeKey()
        The key of the object type.

        Type key’s can be found via the ‘/types’ endpoint.

        Returns:
        the value

      • getCustomPropertyMembers

        public List<CustomPropertySetUsage> getCustomPropertyMembers()
        The list of customized properties along with the values for this object
        Returns:
        the value

      • getProperties

        public Map<String,​Map<String,​String>> getProperties()
        A map of maps that contains the properties which are specific to the connection type.

        Each connection type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the “default” category. To determine the set of optional and required properties for a connection type, a query can be done on ‘/types?type=connection’ that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “username”: “user1”}}}

        Returns:
        the value

      • getEncProperties

        public Map<String,​Map<String,​String>> getEncProperties()
        A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type.

        Each connection type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the “default” category. To determine the set of optional and required properties for a connection type, a query can be done on ‘/types?type=connection’ that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“encProperties”: { “default”: { “password”: “example-password”}}}

        Returns:
        the value

      • getIsDefault

        public Boolean getIsDefault()
        Indicates whether this connection is the default connection.

        The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.

        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