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

Class SftpServerLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.SftpServerLinkedService
public class SftpServerLinkedService extends LinkedService
A linked service for an SSH File Transfer Protocol (SFTP) server.

  • Constructor Details

    • SftpServerLinkedService

      public SftpServerLinkedService()

  • Method Details

    • getHost

      public Object getHost()
      Get the host property: The SFTP server host name. Type: string (or Expression with resultType string).
      Returns:
      the host value.

    • setHost

      public SftpServerLinkedService setHost(Object host)
      Set the host property: The SFTP server host name. Type: string (or Expression with resultType string).
      Parameters:
      host - the host value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getPort

      public Object getPort()
      Get the port property: The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
      Returns:
      the port value.

    • setPort

      public SftpServerLinkedService setPort(Object port)
      Set the port property: The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
      Parameters:
      port - the port value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getAuthenticationType

      public SftpAuthenticationType getAuthenticationType()
      Get the authenticationType property: The authentication type to be used to connect to the FTP server.
      Returns:
      the authenticationType value.

    • setAuthenticationType

      public SftpServerLinkedService setAuthenticationType(SftpAuthenticationType authenticationType)
      Set the authenticationType property: The authentication type to be used to connect to the FTP server.
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getUserName

      public Object getUserName()
      Get the userName property: The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
      Returns:
      the userName value.

    • setUserName

      public SftpServerLinkedService setUserName(Object userName)
      Set the userName property: The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
      Parameters:
      userName - the userName value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getPassword

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

    • setPassword

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

    • getPrivateKeyPath

      public Object getPrivateKeyPath()
      Get the privateKeyPath property: The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
      Returns:
      the privateKeyPath value.

    • setPrivateKeyPath

      public SftpServerLinkedService setPrivateKeyPath(Object privateKeyPath)
      Set the privateKeyPath property: The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
      Parameters:
      privateKeyPath - the privateKeyPath value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getPrivateKeyContent

      public SecretBase getPrivateKeyContent()
      Get the privateKeyContent property: Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
      Returns:
      the privateKeyContent value.

    • setPrivateKeyContent

      public SftpServerLinkedService setPrivateKeyContent(SecretBase privateKeyContent)
      Set the privateKeyContent property: Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
      Parameters:
      privateKeyContent - the privateKeyContent value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getPassPhrase

      public SecretBase getPassPhrase()
      Get the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.
      Returns:
      the passPhrase value.

    • setPassPhrase

      public SftpServerLinkedService setPassPhrase(SecretBase passPhrase)
      Set the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.
      Parameters:
      passPhrase - the passPhrase value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getSkipHostKeyValidation

      public Object getSkipHostKeyValidation()
      Get the skipHostKeyValidation property: If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
      Returns:
      the skipHostKeyValidation value.

    • setSkipHostKeyValidation

      public SftpServerLinkedService setSkipHostKeyValidation(Object skipHostKeyValidation)
      Set the skipHostKeyValidation property: If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
      Parameters:
      skipHostKeyValidation - the skipHostKeyValidation value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • getHostKeyFingerprint

      public Object getHostKeyFingerprint()
      Get the hostKeyFingerprint property: The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
      Returns:
      the hostKeyFingerprint value.

    • setHostKeyFingerprint

      public SftpServerLinkedService setHostKeyFingerprint(Object hostKeyFingerprint)
      Set the hostKeyFingerprint property: The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
      Parameters:
      hostKeyFingerprint - the hostKeyFingerprint value to set.
      Returns:
      the SftpServerLinkedService object itself.

    • setConnectVia

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