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

Class FtpServerLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.FtpServerLinkedService
public class FtpServerLinkedService extends LinkedService
A FTP server Linked Service.

  • Constructor Details

    • FtpServerLinkedService

      public FtpServerLinkedService()

  • Method Details

    • getHost

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

    • setHost

      public FtpServerLinkedService setHost(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.

    • getPort

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

    • setPort

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

    • getAuthenticationType

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

    • setAuthenticationType

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

    • getUserName

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

    • setUserName

      public FtpServerLinkedService setUserName(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.

    • getPassword

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

    • setPassword

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

    • getEnableSsl

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

    • setEnableSsl

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

    • getEnableServerCertificateValidation

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

    • setEnableServerCertificateValidation

      public FtpServerLinkedService setEnableServerCertificateValidation(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.

    • setConnectVia

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