Package com.oracle.bmc.datacatalog.model

Class CreateConnectionDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • description

        public CreateConnectionDetails.Builder description​(String description)
        A description of the connection.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • displayName

        public CreateConnectionDetails.Builder displayName​(String displayName)
        A user-friendly display name.

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

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • typeKey

        public CreateConnectionDetails.Builder typeKey​(String typeKey)
        The key of the object type.

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

        Parameters:
        typeKey - the value to set
        Returns:
        this builder

      • customPropertyMembers

        public CreateConnectionDetails.Builder customPropertyMembers​(List<CustomPropertySetUsage> customPropertyMembers)
        The list of customized properties along with the values for this object
        Parameters:
        customPropertyMembers - the value to set
        Returns:
        this builder

      • properties

        public CreateConnectionDetails.Builder properties​(Map<String,​Map<String,​String>> properties)
        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”}}}

        Parameters:
        properties - the value to set
        Returns:
        this builder

      • encProperties

        public CreateConnectionDetails.Builder encProperties​(Map<String,​Map<String,​String>> encProperties)
        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”}}}

        Parameters:
        encProperties - the value to set
        Returns:
        this builder

      • isDefault

        public CreateConnectionDetails.Builder isDefault​(Boolean isDefault)
        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.

        Parameters:
        isDefault - the value to set
        Returns:
        this builder