FtpServerLinkedService Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.28

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.LinkedService
  • • com.azure.resourcemanager.datafactory.models.FtpServerLinkedService

public final class FtpServerLinkedService
extends LinkedService

A FTP server Linked Service.

Constructor Summary

Constructor	Description
FtpServerLinkedService()	Creates an instance of FtpServerLinkedService class.

Method Summary

Modifier and Type	Method and Description
FtpAuthenticationType	authenticationType() Get the authenticationType property: The authentication type to be used to connect to the FTP server.
Object	enableServerCertificateValidation() Get the enableServerCertificateValidation property: If true, validate the FTP server SSL certificate when connect over SSL/TLS channel.
Object	enableSsl() Get the enableSsl property: If true, connect to the FTP server over SSL/TLS channel.
String	encryptedCredential() Get the encryptedCredential property: The encrypted credential used for authentication.
Object	host() Get the host property: Host name of the FTP server.
SecretBase	password() Get the password property: Password to logon the FTP server.
Object	port() Get the port property: The TCP port number that the FTP server uses to listen for client connections.
String	type() Get the type property: Type of linked service.
Object	username() Get the username property: Username to logon the FTP server.
void	validate() Validates the instance.
FtpServerLinkedService	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
FtpServerLinkedService	withAuthenticationType(FtpAuthenticationType authenticationType) Set the authenticationType property: The authentication type to be used to connect to the FTP server.
FtpServerLinkedService	withConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
FtpServerLinkedService	withDescription(String description) Set the description property: Linked service description.
FtpServerLinkedService	withEnableServerCertificateValidation(Object enableServerCertificateValidation) Set the enableServerCertificateValidation property: If true, validate the FTP server SSL certificate when connect over SSL/TLS channel.
FtpServerLinkedService	withEnableSsl(Object enableSsl) Set the enableSsl property: If true, connect to the FTP server over SSL/TLS channel.
FtpServerLinkedService	withEncryptedCredential(String encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
FtpServerLinkedService	withHost(Object host) Set the host property: Host name of the FTP server.
FtpServerLinkedService	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
FtpServerLinkedService	withPassword(SecretBase password) Set the password property: Password to logon the FTP server.
FtpServerLinkedService	withPort(Object port) Set the port property: The TCP port number that the FTP server uses to listen for client connections.
FtpServerLinkedService	withUsername(Object username) Set the username property: Username to logon the FTP server.

Methods inherited from LinkedService

additionalProperties annotations connectVia description parameters type validate withAdditionalProperties withAnnotations withConnectVia withDescription withParameters

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FtpServerLinkedService

public FtpServerLinkedService()

Creates an instance of FtpServerLinkedService class.

Method Details

authenticationType

public FtpAuthenticationType authenticationType()

Get the authenticationType property: The authentication type to be used to connect to the FTP server.

Returns:

the authenticationType value.

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.

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.

encryptedCredential

public String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Returns:

the encryptedCredential value.

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.

password

public SecretBase password()

Get the password property: Password to logon the FTP server.

Returns:

the password value.

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.

type

public String type()

Get the type property: Type of linked service.

Overrides:

FtpServerLinkedService.type()

Returns:

the type value.

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.

validate

public void validate()

Validates the instance.

Overrides:

FtpServerLinkedService.validate()

withAnnotations

public FtpServerLinkedService withAnnotations(List

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

FtpServerLinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

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.

withConnectVia

public FtpServerLinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

FtpServerLinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

withDescription

public FtpServerLinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

FtpServerLinkedService.withDescription(String description)

Parameters:

description

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.

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.

withEncryptedCredential

public FtpServerLinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the FtpServerLinkedService object itself.

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.

withParameters

public FtpServerLinkedService withParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

FtpServerLinkedService.withParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

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.

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.

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.