Class MongoDbLinkedService


  • public final class MongoDbLinkedService
    extends LinkedService
    Linked service for MongoDb data source.
    • Constructor Detail

      • MongoDbLinkedService

        public MongoDbLinkedService()
    • Method Detail

      • withDescription

        public MongoDbLinkedService withDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        withDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.
      • withAnnotations

        public MongoDbLinkedService withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        withAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.
      • server

        public Object server()
        Get the server property: The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).
        Returns:
        the server value.
      • withServer

        public MongoDbLinkedService withServer​(Object server)
        Set the server property: The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).
        Parameters:
        server - the server value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • authenticationType

        public MongoDbAuthenticationType authenticationType()
        Get the authenticationType property: The authentication type to be used to connect to the MongoDB database.
        Returns:
        the authenticationType value.
      • withAuthenticationType

        public MongoDbLinkedService withAuthenticationType​(MongoDbAuthenticationType authenticationType)
        Set the authenticationType property: The authentication type to be used to connect to the MongoDB database.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • databaseName

        public Object databaseName()
        Get the databaseName property: The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
        Returns:
        the databaseName value.
      • withDatabaseName

        public MongoDbLinkedService withDatabaseName​(Object databaseName)
        Set the databaseName property: The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
        Parameters:
        databaseName - the databaseName value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • username

        public Object username()
        Get the username property: Username for authentication. Type: string (or Expression with resultType string).
        Returns:
        the username value.
      • withUsername

        public MongoDbLinkedService withUsername​(Object username)
        Set the username property: Username for authentication. Type: string (or Expression with resultType string).
        Parameters:
        username - the username value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • password

        public SecretBase password()
        Get the password property: Password for authentication.
        Returns:
        the password value.
      • withPassword

        public MongoDbLinkedService withPassword​(SecretBase password)
        Set the password property: Password for authentication.
        Parameters:
        password - the password value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • authSource

        public Object authSource()
        Get the authSource property: Database to verify the username and password. Type: string (or Expression with resultType string).
        Returns:
        the authSource value.
      • withAuthSource

        public MongoDbLinkedService withAuthSource​(Object authSource)
        Set the authSource property: Database to verify the username and password. Type: string (or Expression with resultType string).
        Parameters:
        authSource - the authSource value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • port

        public Object port()
        Get the port property: The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.
        Returns:
        the port value.
      • withPort

        public MongoDbLinkedService withPort​(Object port)
        Set the port property: The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.
        Parameters:
        port - the port value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • enableSsl

        public Object enableSsl()
        Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).
        Returns:
        the enableSsl value.
      • withEnableSsl

        public MongoDbLinkedService withEnableSsl​(Object enableSsl)
        Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).
        Parameters:
        enableSsl - the enableSsl value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • allowSelfSignedServerCert

        public Object allowSelfSignedServerCert()
        Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).
        Returns:
        the allowSelfSignedServerCert value.
      • withAllowSelfSignedServerCert

        public MongoDbLinkedService withAllowSelfSignedServerCert​(Object allowSelfSignedServerCert)
        Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).
        Parameters:
        allowSelfSignedServerCert - the allowSelfSignedServerCert value to set.
        Returns:
        the MongoDbLinkedService object itself.
      • encryptedCredential

        public Object encryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.
      • withEncryptedCredential

        public MongoDbLinkedService withEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the MongoDbLinkedService object itself.