Package com.azure.analytics.synapse.artifacts.models

Class MongoDbLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.MongoDbLinkedService
public class MongoDbLinkedService extends LinkedService
Linked service for MongoDb data source.

  • Constructor Details

    • MongoDbLinkedService

      public MongoDbLinkedService()

  • Method Details

    • getServer

      public Object getServer()
      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.

    • setServer

      public MongoDbLinkedService setServer(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.

    • getAuthenticationType

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

    • setAuthenticationType

      public MongoDbLinkedService setAuthenticationType(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.

    • getDatabaseName

      public Object getDatabaseName()
      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.

    • setDatabaseName

      public MongoDbLinkedService setDatabaseName(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.

    • getUsername

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

    • setUsername

      public MongoDbLinkedService setUsername(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.

    • getPassword

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

    • setPassword

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

    • getAuthSource

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

    • setAuthSource

      public MongoDbLinkedService setAuthSource(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.

    • getPort

      public Object getPort()
      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.

    • setPort

      public MongoDbLinkedService setPort(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.

    • getEnableSsl

      public Object getEnableSsl()
      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.

    • setEnableSsl

      public MongoDbLinkedService setEnableSsl(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.

    • getAllowSelfSignedServerCert

      public Object getAllowSelfSignedServerCert()
      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.

    • setAllowSelfSignedServerCert

      public MongoDbLinkedService setAllowSelfSignedServerCert(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.

    • getEncryptedCredential

      public Object getEncryptedCredential()
      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.

    • setEncryptedCredential

      public MongoDbLinkedService setEncryptedCredential(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.

    • setConnectVia

      public MongoDbLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
      Set the connectVia property: The integration runtime reference.
      Overrides:
      setConnectVia in class LinkedService
      Parameters:
      connectVia - the connectVia value to set.
      Returns:
      the LinkedService object itself.

    • setDescription

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

    • setParameters

      public MongoDbLinkedService setParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for linked service.
      Overrides:
      setParameters in class LinkedService
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the LinkedService object itself.

    • setAnnotations

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