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

Class OdbcLinkedService

  • public class OdbcLinkedService
extends LinkedService
    Open Database Connectivity (ODBC) linked service.

    • Constructor Detail

      • OdbcLinkedService

        public OdbcLinkedService()

    • Method Detail

      • getConnectionString

        public Object getConnectionString()
        Get the connectionString property: The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
        Returns:
        the connectionString value.

      • setConnectionString

        public OdbcLinkedService setConnectionString​(Object connectionString)
        Set the connectionString property: The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the OdbcLinkedService object itself.

      • getAuthenticationType

        public Object getAuthenticationType()
        Get the authenticationType property: Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
        Returns:
        the authenticationType value.

      • setAuthenticationType

        public OdbcLinkedService setAuthenticationType​(Object authenticationType)
        Set the authenticationType property: Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the OdbcLinkedService object itself.

      • getCredential

        public SecretBase getCredential()
        Get the credential property: The access credential portion of the connection string specified in driver-specific property-value format.
        Returns:
        the credential value.

      • setCredential

        public OdbcLinkedService setCredential​(SecretBase credential)
        Set the credential property: The access credential portion of the connection string specified in driver-specific property-value format.
        Parameters:
        credential - the credential value to set.
        Returns:
        the OdbcLinkedService object itself.

      • getUserName

        public Object getUserName()
        Get the userName property: User name for Basic authentication. Type: string (or Expression with resultType string).
        Returns:
        the userName value.

      • setUserName

        public OdbcLinkedService setUserName​(Object userName)
        Set the userName property: User name for Basic authentication. Type: string (or Expression with resultType string).
        Parameters:
        userName - the userName value to set.
        Returns:
        the OdbcLinkedService object itself.

      • getPassword

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

      • setPassword

        public OdbcLinkedService setPassword​(SecretBase password)
        Set the password property: Password for Basic authentication.
        Parameters:
        password - the password value to set.
        Returns:
        the OdbcLinkedService 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 OdbcLinkedService 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 OdbcLinkedService object itself.

      • setDescription

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