SftpServerLinkedService.java
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.analytics.synapse.artifacts.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.annotation.JsonFlatten;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;
/** A linked service for an SSH File Transfer Protocol (SFTP) server. */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonTypeName("Sftp")
@JsonFlatten
@Fluent
public class SftpServerLinkedService extends LinkedService {
/*
* The SFTP server host name. Type: string (or Expression with resultType
* string).
*/
@JsonProperty(value = "typeProperties.host", required = true)
private Object host;
/*
* 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.
*/
@JsonProperty(value = "typeProperties.port")
private Object port;
/*
* The authentication type to be used to connect to the FTP server.
*/
@JsonProperty(value = "typeProperties.authenticationType")
private SftpAuthenticationType authenticationType;
/*
* The username used to log on to the SFTP server. Type: string (or
* Expression with resultType string).
*/
@JsonProperty(value = "typeProperties.userName")
private Object userName;
/*
* Password to logon the SFTP server for Basic authentication.
*/
@JsonProperty(value = "typeProperties.password")
private SecretBase password;
/*
* The encrypted credential used for authentication. Credentials are
* encrypted using the integration runtime credential manager. Type: string
* (or Expression with resultType string).
*/
@JsonProperty(value = "typeProperties.encryptedCredential")
private Object encryptedCredential;
/*
* 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).
*/
@JsonProperty(value = "typeProperties.privateKeyPath")
private Object privateKeyPath;
/*
* 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.
*/
@JsonProperty(value = "typeProperties.privateKeyContent")
private SecretBase privateKeyContent;
/*
* The password to decrypt the SSH private key if the SSH private key is
* encrypted.
*/
@JsonProperty(value = "typeProperties.passPhrase")
private SecretBase passPhrase;
/*
* If true, skip the SSH host key validation. Default value is false. Type:
* boolean (or Expression with resultType boolean).
*/
@JsonProperty(value = "typeProperties.skipHostKeyValidation")
private Object skipHostKeyValidation;
/*
* The host key finger-print of the SFTP server. When SkipHostKeyValidation
* is false, HostKeyFingerprint should be specified. Type: string (or
* Expression with resultType string).
*/
@JsonProperty(value = "typeProperties.hostKeyFingerprint")
private Object hostKeyFingerprint;
/**
* Get the host property: The SFTP server host name. Type: string (or Expression with resultType string).
*
* @return the host value.
*/
public Object getHost() {
return this.host;
}
/**
* Set the host property: The SFTP server host name. Type: string (or Expression with resultType string).
*
* @param host the host value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setHost(Object host) {
this.host = host;
return this;
}
/**
* 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.
*
* @return the port value.
*/
public Object getPort() {
return this.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.
*
* @param port the port value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setPort(Object port) {
this.port = port;
return this;
}
/**
* Get the authenticationType property: The authentication type to be used to connect to the FTP server.
*
* @return the authenticationType value.
*/
public SftpAuthenticationType getAuthenticationType() {
return this.authenticationType;
}
/**
* Set the authenticationType property: The authentication type to be used to connect to the FTP server.
*
* @param authenticationType the authenticationType value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setAuthenticationType(SftpAuthenticationType authenticationType) {
this.authenticationType = authenticationType;
return this;
}
/**
* Get the userName property: The username used to log on to the SFTP server. Type: string (or Expression with
* resultType string).
*
* @return the userName value.
*/
public Object getUserName() {
return this.userName;
}
/**
* Set the userName property: The username used to log on to the SFTP server. Type: string (or Expression with
* resultType string).
*
* @param userName the userName value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setUserName(Object userName) {
this.userName = userName;
return this;
}
/**
* Get the password property: Password to logon the SFTP server for Basic authentication.
*
* @return the password value.
*/
public SecretBase getPassword() {
return this.password;
}
/**
* Set the password property: Password to logon the SFTP server for Basic authentication.
*
* @param password the password value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setPassword(SecretBase password) {
this.password = password;
return this;
}
/**
* 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).
*
* @return the encryptedCredential value.
*/
public Object getEncryptedCredential() {
return this.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).
*
* @param encryptedCredential the encryptedCredential value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setEncryptedCredential(Object encryptedCredential) {
this.encryptedCredential = encryptedCredential;
return this;
}
/**
* 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).
*
* @return the privateKeyPath value.
*/
public Object getPrivateKeyPath() {
return this.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).
*
* @param privateKeyPath the privateKeyPath value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setPrivateKeyPath(Object privateKeyPath) {
this.privateKeyPath = privateKeyPath;
return this;
}
/**
* 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.
*
* @return the privateKeyContent value.
*/
public SecretBase getPrivateKeyContent() {
return this.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.
*
* @param privateKeyContent the privateKeyContent value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setPrivateKeyContent(SecretBase privateKeyContent) {
this.privateKeyContent = privateKeyContent;
return this;
}
/**
* Get the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.
*
* @return the passPhrase value.
*/
public SecretBase getPassPhrase() {
return this.passPhrase;
}
/**
* Set the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.
*
* @param passPhrase the passPhrase value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setPassPhrase(SecretBase passPhrase) {
this.passPhrase = passPhrase;
return this;
}
/**
* Get the skipHostKeyValidation property: If true, skip the SSH host key validation. Default value is false. Type:
* boolean (or Expression with resultType boolean).
*
* @return the skipHostKeyValidation value.
*/
public Object getSkipHostKeyValidation() {
return this.skipHostKeyValidation;
}
/**
* Set the skipHostKeyValidation property: If true, skip the SSH host key validation. Default value is false. Type:
* boolean (or Expression with resultType boolean).
*
* @param skipHostKeyValidation the skipHostKeyValidation value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setSkipHostKeyValidation(Object skipHostKeyValidation) {
this.skipHostKeyValidation = skipHostKeyValidation;
return this;
}
/**
* 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).
*
* @return the hostKeyFingerprint value.
*/
public Object getHostKeyFingerprint() {
return this.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).
*
* @param hostKeyFingerprint the hostKeyFingerprint value to set.
* @return the SftpServerLinkedService object itself.
*/
public SftpServerLinkedService setHostKeyFingerprint(Object hostKeyFingerprint) {
this.hostKeyFingerprint = hostKeyFingerprint;
return this;
}
}