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

Class Db2LinkedService

  • public class Db2LinkedService
extends LinkedService
    Linked service for DB2 data source.

    • Constructor Detail

      • Db2LinkedService

        public Db2LinkedService()

    • Method Detail

      • getConnectionString

        public Object getConnectionString()
        Get the connectionString property: The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Returns:
        the connectionString value.

      • setConnectionString

        public Db2LinkedService setConnectionString​(Object connectionString)
        Set the connectionString property: The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the Db2LinkedService object itself.

      • getServer

        public Object getServer()
        Get the server property: Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Returns:
        the server value.

      • setServer

        public Db2LinkedService setServer​(Object server)
        Set the server property: Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Parameters:
        server - the server value to set.
        Returns:
        the Db2LinkedService object itself.

      • getDatabase

        public Object getDatabase()
        Get the database property: Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Returns:
        the database value.

      • setDatabase

        public Db2LinkedService setDatabase​(Object database)
        Set the database property: Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Parameters:
        database - the database value to set.
        Returns:
        the Db2LinkedService object itself.

      • getAuthenticationType

        public Db2AuthenticationType getAuthenticationType()
        Get the authenticationType property: AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.
        Returns:
        the authenticationType value.

      • setAuthenticationType

        public Db2LinkedService setAuthenticationType​(Db2AuthenticationType authenticationType)
        Set the authenticationType property: AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the Db2LinkedService object itself.

      • getUsername

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

      • setUsername

        public Db2LinkedService setUsername​(Object username)
        Set the username property: Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Parameters:
        username - the username value to set.
        Returns:
        the Db2LinkedService object itself.

      • getPassword

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

      • setPassword

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

      • getPackageCollection

        public Object getPackageCollection()
        Get the packageCollection property: Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Returns:
        the packageCollection value.

      • setPackageCollection

        public Db2LinkedService setPackageCollection​(Object packageCollection)
        Set the packageCollection property: Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Parameters:
        packageCollection - the packageCollection value to set.
        Returns:
        the Db2LinkedService object itself.

      • getCertificateCommonName

        public Object getCertificateCommonName()
        Get the certificateCommonName property: Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Returns:
        the certificateCommonName value.

      • setCertificateCommonName

        public Db2LinkedService setCertificateCommonName​(Object certificateCommonName)
        Set the certificateCommonName property: Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Parameters:
        certificateCommonName - the certificateCommonName value to set.
        Returns:
        the Db2LinkedService 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. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.

      • setEncryptedCredential

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

      • setDescription

        public Db2LinkedService 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.

      • setAnnotations

        public Db2LinkedService 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.