Class HiveLinkedService
java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.HiveLinkedService
Hive 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 method used to access the Hive 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: IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).Get the httpPath property: The partial URL corresponding to the Hive server.Get the password property: The password corresponding to the user name that you provided in the Username field.getPort()
Get the port property: The TCP port that the Hive server uses to listen for client connections.Get the serverType property: The type of Hive server.Get the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.Get the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.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 useNativeQuery property: Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.Get the username property: The user name that you use to access Hive Server.Get the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file.Get the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.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
(HiveAuthenticationType authenticationType) Set the authenticationType property: The authentication method used to access the Hive 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: IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).setHttpPath
(Object httpPath) Set the httpPath property: The partial URL corresponding to the Hive 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 that you provided in the Username field.Set the port property: The TCP port that the Hive server uses to listen for client connections.setServerType
(HiveServerType serverType) Set the serverType property: The type of Hive server.setServiceDiscoveryMode
(Object serviceDiscoveryMode) Set the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.setThriftTransportProtocol
(HiveThriftTransportProtocol thriftTransportProtocol) Set the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.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.setUseNativeQuery
(Object useNativeQuery) Set the useNativeQuery property: Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.setUsername
(Object username) Set the username property: The user name that you use to access Hive 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.setZooKeeperNameSpace
(Object zooKeeperNameSpace) Set the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService
getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties
-
Constructor Details
-
HiveLinkedService
public HiveLinkedService()
-
-
Method Details
-
getHost
Get the host property: IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).- Returns:
- the host value.
-
setHost
Set the host property: IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).- Parameters:
host
- the host value to set.- Returns:
- the HiveLinkedService object itself.
-
getPort
Get the port property: The TCP port that the Hive server uses to listen for client connections.- Returns:
- the port value.
-
setPort
Set the port property: The TCP port that the Hive server uses to listen for client connections.- Parameters:
port
- the port value to set.- Returns:
- the HiveLinkedService object itself.
-
getServerType
Get the serverType property: The type of Hive server.- Returns:
- the serverType value.
-
setServerType
Set the serverType property: The type of Hive server.- Parameters:
serverType
- the serverType value to set.- Returns:
- the HiveLinkedService object itself.
-
getThriftTransportProtocol
Get the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.- Returns:
- the thriftTransportProtocol value.
-
setThriftTransportProtocol
public HiveLinkedService setThriftTransportProtocol(HiveThriftTransportProtocol thriftTransportProtocol) Set the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.- Parameters:
thriftTransportProtocol
- the thriftTransportProtocol value to set.- Returns:
- the HiveLinkedService object itself.
-
getAuthenticationType
Get the authenticationType property: The authentication method used to access the Hive server.- Returns:
- the authenticationType value.
-
setAuthenticationType
Set the authenticationType property: The authentication method used to access the Hive server.- Parameters:
authenticationType
- the authenticationType value to set.- Returns:
- the HiveLinkedService object itself.
-
getServiceDiscoveryMode
Get the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.- Returns:
- the serviceDiscoveryMode value.
-
setServiceDiscoveryMode
Set the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.- Parameters:
serviceDiscoveryMode
- the serviceDiscoveryMode value to set.- Returns:
- the HiveLinkedService object itself.
-
getZooKeeperNameSpace
Get the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.- Returns:
- the zooKeeperNameSpace value.
-
setZooKeeperNameSpace
Set the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.- Parameters:
zooKeeperNameSpace
- the zooKeeperNameSpace value to set.- Returns:
- the HiveLinkedService object itself.
-
getUseNativeQuery
Get the useNativeQuery property: Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.- Returns:
- the useNativeQuery value.
-
setUseNativeQuery
Set the useNativeQuery property: Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.- Parameters:
useNativeQuery
- the useNativeQuery value to set.- Returns:
- the HiveLinkedService object itself.
-
getUsername
Get the username property: The user name that you use to access Hive Server.- Returns:
- the username value.
-
setUsername
Set the username property: The user name that you use to access Hive Server.- Parameters:
username
- the username value to set.- Returns:
- the HiveLinkedService object itself.
-
getPassword
Get the password property: The password corresponding to the user name that you provided in the Username field.- Returns:
- the password value.
-
setPassword
Set the password property: The password corresponding to the user name that you provided in the Username field.- Parameters:
password
- the password value to set.- Returns:
- the HiveLinkedService object itself.
-
getHttpPath
Get the httpPath property: The partial URL corresponding to the Hive server.- Returns:
- the httpPath value.
-
setHttpPath
Set the httpPath property: The partial URL corresponding to the Hive server.- Parameters:
httpPath
- the httpPath value to set.- Returns:
- the HiveLinkedService 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 HiveLinkedService 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 HiveLinkedService 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 HiveLinkedService 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 HiveLinkedService 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 HiveLinkedService 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 HiveLinkedService 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.
-