Class FtpServerLinkedService


  • public final class FtpServerLinkedService
    extends LinkedService
    A FTP server Linked Service.
    • Constructor Detail

      • FtpServerLinkedService

        public FtpServerLinkedService()
    • Method Detail

      • withDescription

        public FtpServerLinkedService 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 FtpServerLinkedService 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.
      • host

        public Object host()
        Get the host property: Host name of the FTP server. Type: string (or Expression with resultType string).
        Returns:
        the host value.
      • withHost

        public FtpServerLinkedService withHost​(Object host)
        Set the host property: Host name of the FTP server. Type: string (or Expression with resultType string).
        Parameters:
        host - the host value to set.
        Returns:
        the FtpServerLinkedService object itself.
      • port

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

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

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

        public FtpServerLinkedService withAuthenticationType​(FtpAuthenticationType 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 FtpServerLinkedService object itself.
      • username

        public Object username()
        Get the username property: Username to logon the FTP server. Type: string (or Expression with resultType string).
        Returns:
        the username value.
      • withUsername

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

        public SecretBase password()
        Get the password property: Password to logon the FTP server.
        Returns:
        the password value.
      • withPassword

        public FtpServerLinkedService withPassword​(SecretBase password)
        Set the password property: Password to logon the FTP server.
        Parameters:
        password - the password value to set.
        Returns:
        the FtpServerLinkedService 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 FtpServerLinkedService 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 FtpServerLinkedService object itself.
      • enableSsl

        public Object enableSsl()
        Get the enableSsl property: If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
        Returns:
        the enableSsl value.
      • withEnableSsl

        public FtpServerLinkedService withEnableSsl​(Object enableSsl)
        Set the enableSsl property: If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
        Parameters:
        enableSsl - the enableSsl value to set.
        Returns:
        the FtpServerLinkedService object itself.
      • enableServerCertificateValidation

        public Object enableServerCertificateValidation()
        Get the enableServerCertificateValidation property: If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
        Returns:
        the enableServerCertificateValidation value.
      • withEnableServerCertificateValidation

        public FtpServerLinkedService withEnableServerCertificateValidation​(Object enableServerCertificateValidation)
        Set the enableServerCertificateValidation property: If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
        Parameters:
        enableServerCertificateValidation - the enableServerCertificateValidation value to set.
        Returns:
        the FtpServerLinkedService object itself.