Class HiveLinkedService
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.LinkedService
-
- com.azure.analytics.synapse.artifacts.models.HiveLinkedService
-
public class HiveLinkedService extends LinkedService
Hive Server linked service.
-
-
Constructor Summary
Constructors Constructor Description HiveLinkedService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
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.Object
getAllowSelfSignedServerCert()
Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.HiveAuthenticationType
getAuthenticationType()
Get the authenticationType property: The authentication method used to access the Hive server.Object
getEnableSsl()
Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.Object
getEncryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication.Object
getHost()
Get the host property: IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).Object
getHttpPath()
Get the httpPath property: The partial URL corresponding to the Hive server.SecretBase
getPassword()
Get the password property: The password corresponding to the user name that you provided in the Username field.Object
getPort()
Get the port property: The TCP port that the Hive server uses to listen for client connections.HiveServerType
getServerType()
Get the serverType property: The type of Hive server.Object
getServiceDiscoveryMode()
Get the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.HiveThriftTransportProtocol
getThriftTransportProtocol()
Get the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.Object
getTrustedCertPath()
Get the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL.Object
getUseNativeQuery()
Get the useNativeQuery property: Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.Object
getUsername()
Get the username property: The user name that you use to access Hive Server.Object
getUseSystemTrustStore()
Get the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file.Object
getZooKeeperNameSpace()
Get the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.HiveLinkedService
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.HiveLinkedService
setAllowSelfSignedServerCert(Object allowSelfSignedServerCert)
Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.HiveLinkedService
setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service.HiveLinkedService
setAuthenticationType(HiveAuthenticationType authenticationType)
Set the authenticationType property: The authentication method used to access the Hive server.HiveLinkedService
setConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.HiveLinkedService
setDescription(String description)
Set the description property: Linked service description.HiveLinkedService
setEnableSsl(Object enableSsl)
Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.HiveLinkedService
setEncryptedCredential(Object encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication.HiveLinkedService
setHost(Object host)
Set the host property: IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).HiveLinkedService
setHttpPath(Object httpPath)
Set the httpPath property: The partial URL corresponding to the Hive server.HiveLinkedService
setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service.HiveLinkedService
setPassword(SecretBase password)
Set the password property: The password corresponding to the user name that you provided in the Username field.HiveLinkedService
setPort(Object port)
Set the port property: The TCP port that the Hive server uses to listen for client connections.HiveLinkedService
setServerType(HiveServerType serverType)
Set the serverType property: The type of Hive server.HiveLinkedService
setServiceDiscoveryMode(Object serviceDiscoveryMode)
Set the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.HiveLinkedService
setThriftTransportProtocol(HiveThriftTransportProtocol thriftTransportProtocol)
Set the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.HiveLinkedService
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.HiveLinkedService
setUseNativeQuery(Object useNativeQuery)
Set the useNativeQuery property: Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.HiveLinkedService
setUsername(Object username)
Set the username property: The user name that you use to access Hive Server.HiveLinkedService
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.HiveLinkedService
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
-
-
-
-
Method Detail
-
getHost
public Object 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
public HiveLinkedService setHost(Object host)
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
public Object getPort()
Get the port property: The TCP port that the Hive server uses to listen for client connections.- Returns:
- the port value.
-
setPort
public HiveLinkedService setPort(Object port)
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
public HiveServerType getServerType()
Get the serverType property: The type of Hive server.- Returns:
- the serverType value.
-
setServerType
public HiveLinkedService setServerType(HiveServerType serverType)
Set the serverType property: The type of Hive server.- Parameters:
serverType
- the serverType value to set.- Returns:
- the HiveLinkedService object itself.
-
getThriftTransportProtocol
public HiveThriftTransportProtocol 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
public HiveAuthenticationType getAuthenticationType()
Get the authenticationType property: The authentication method used to access the Hive server.- Returns:
- the authenticationType value.
-
setAuthenticationType
public HiveLinkedService setAuthenticationType(HiveAuthenticationType authenticationType)
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
public Object getServiceDiscoveryMode()
Get the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.- Returns:
- the serviceDiscoveryMode value.
-
setServiceDiscoveryMode
public HiveLinkedService setServiceDiscoveryMode(Object serviceDiscoveryMode)
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
public Object getZooKeeperNameSpace()
Get the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.- Returns:
- the zooKeeperNameSpace value.
-
setZooKeeperNameSpace
public HiveLinkedService setZooKeeperNameSpace(Object zooKeeperNameSpace)
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
public Object 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
public HiveLinkedService setUseNativeQuery(Object useNativeQuery)
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
public Object getUsername()
Get the username property: The user name that you use to access Hive Server.- Returns:
- the username value.
-
setUsername
public HiveLinkedService setUsername(Object username)
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
public SecretBase getPassword()
Get the password property: The password corresponding to the user name that you provided in the Username field.- Returns:
- the password value.
-
setPassword
public HiveLinkedService setPassword(SecretBase password)
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
public Object getHttpPath()
Get the httpPath property: The partial URL corresponding to the Hive server.- Returns:
- the httpPath value.
-
setHttpPath
public HiveLinkedService setHttpPath(Object httpPath)
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
public Object 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
public HiveLinkedService setEnableSsl(Object enableSsl)
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
public Object 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
public HiveLinkedService 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. 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
public Object 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
public HiveLinkedService 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. The default value is false.- Parameters:
useSystemTrustStore
- the useSystemTrustStore value to set.- Returns:
- the HiveLinkedService object itself.
-
getAllowHostNameCNMismatch
public Object 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
public HiveLinkedService 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. The default value is false.- Parameters:
allowHostNameCNMismatch
- the allowHostNameCNMismatch value to set.- Returns:
- the HiveLinkedService object itself.
-
getAllowSelfSignedServerCert
public Object 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
public HiveLinkedService setAllowSelfSignedServerCert(Object allowSelfSignedServerCert)
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
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 HiveLinkedService 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 HiveLinkedService object itself.
-
setConnectVia
public HiveLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
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
public HiveLinkedService setDescription(String description)
Set the description property: Linked service description.- Overrides:
setDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
setParameters
public HiveLinkedService setParameters(Map<String,ParameterSpecification> parameters)
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
public HiveLinkedService setAnnotations(List<Object> annotations)
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.
-
-