Class PhoenixLinkedService
java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.PhoenixLinkedService
Phoenix server linked service.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the allowHostNameCNMismatch property: Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL.Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.Get the authenticationType property: The authentication mechanism used to connect to the Phoenix server.Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.Get the encryptedCredential property: The encrypted credential used for authentication.getHost()
Get the host property: The IP address or host name of the Phoenix server.Get the httpPath property: The partial URL corresponding to the Phoenix server.Get the password property: The password corresponding to the user name.getPort()
Get the port property: The TCP port that the Phoenix server uses to listen for client connections.Get the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL.Get the username property: The user name used to connect to the Phoenix server.Get the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file.setAllowHostNameCNMismatch
(Object allowHostNameCNMismatch) Set the allowHostNameCNMismatch property: Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL.setAllowSelfSignedServerCert
(Object allowSelfSignedServerCert) Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.setAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.setAuthenticationType
(PhoenixAuthenticationType authenticationType) Set the authenticationType property: The authentication mechanism used to connect to the Phoenix server.setConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.setDescription
(String description) Set the description property: Linked service description.setEnableSsl
(Object enableSsl) Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.setEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.Set the host property: The IP address or host name of the Phoenix server.setHttpPath
(Object httpPath) Set the httpPath property: The partial URL corresponding to the Phoenix server.setParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.setPassword
(SecretBase password) Set the password property: The password corresponding to the user name.Set the port property: The TCP port that the Phoenix server uses to listen for client connections.setTrustedCertPath
(Object trustedCertPath) Set the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL.setUsername
(Object username) Set the username property: The user name used to connect to the Phoenix server.setUseSystemTrustStore
(Object useSystemTrustStore) Set the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file.Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService
getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties
-
Constructor Details
-
PhoenixLinkedService
public PhoenixLinkedService()Creates an instance of PhoenixLinkedService class.
-
-
Method Details
-
getHost
Get the host property: The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).- Returns:
- the host value.
-
setHost
Set the host property: The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).- Parameters:
host
- the host value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getPort
Get the port property: The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.- Returns:
- the port value.
-
setPort
Set the port property: The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.- Parameters:
port
- the port value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getHttpPath
Get the httpPath property: The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.- Returns:
- the httpPath value.
-
setHttpPath
Set the httpPath property: The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.- Parameters:
httpPath
- the httpPath value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getAuthenticationType
Get the authenticationType property: The authentication mechanism used to connect to the Phoenix server.- Returns:
- the authenticationType value.
-
setAuthenticationType
Set the authenticationType property: The authentication mechanism used to connect to the Phoenix server.- Parameters:
authenticationType
- the authenticationType value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getUsername
Get the username property: The user name used to connect to the Phoenix server.- Returns:
- the username value.
-
setUsername
Set the username property: The user name used to connect to the Phoenix server.- Parameters:
username
- the username value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getPassword
Get the password property: The password corresponding to the user name.- Returns:
- the password value.
-
setPassword
Set the password property: The password corresponding to the user name.- Parameters:
password
- the password value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getEnableSsl
Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false.- Returns:
- the enableSsl value.
-
setEnableSsl
Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false.- Parameters:
enableSsl
- the enableSsl value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getTrustedCertPath
Get the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.- Returns:
- the trustedCertPath value.
-
setTrustedCertPath
Set the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.- Parameters:
trustedCertPath
- the trustedCertPath value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getUseSystemTrustStore
Get the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.- Returns:
- the useSystemTrustStore value.
-
setUseSystemTrustStore
Set the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.- Parameters:
useSystemTrustStore
- the useSystemTrustStore value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getAllowHostNameCNMismatch
Get the allowHostNameCNMismatch property: Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.- Returns:
- the allowHostNameCNMismatch value.
-
setAllowHostNameCNMismatch
Set the allowHostNameCNMismatch property: Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.- Parameters:
allowHostNameCNMismatch
- the allowHostNameCNMismatch value to set.- Returns:
- the PhoenixLinkedService object itself.
-
getAllowSelfSignedServerCert
Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false.- Returns:
- the allowSelfSignedServerCert value.
-
setAllowSelfSignedServerCert
Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false.- Parameters:
allowSelfSignedServerCert
- the allowSelfSignedServerCert value to set.- Returns:
- the PhoenixLinkedService object itself.
-
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
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 PhoenixLinkedService object itself.
-
setConnectVia
Set the connectVia property: The integration runtime reference.- Overrides:
setConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
setDescription
Set the description property: Linked service description.- Overrides:
setDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
setParameters
Set the parameters property: Parameters for linked service.- Overrides:
setParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
setAnnotations
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
setAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-