Class HiveLinkedService


  • public final class HiveLinkedService
    extends LinkedService
    Hive Server linked service.
    • Constructor Detail

      • HiveLinkedService

        public HiveLinkedService()
    • Method Detail

      • withDescription

        public HiveLinkedService withDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        withDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.
      • withAnnotations

        public HiveLinkedService withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        withAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.
      • host

        public Object host()
        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.
      • withHost

        public HiveLinkedService withHost​(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.
      • port

        public Object port()
        Get the port property: The TCP port that the Hive server uses to listen for client connections.
        Returns:
        the port value.
      • withPort

        public HiveLinkedService withPort​(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.
      • serverType

        public HiveServerType serverType()
        Get the serverType property: The type of Hive server.
        Returns:
        the serverType value.
      • withServerType

        public HiveLinkedService withServerType​(HiveServerType serverType)
        Set the serverType property: The type of Hive server.
        Parameters:
        serverType - the serverType value to set.
        Returns:
        the HiveLinkedService object itself.
      • thriftTransportProtocol

        public HiveThriftTransportProtocol thriftTransportProtocol()
        Get the thriftTransportProtocol property: The transport protocol to use in the Thrift layer.
        Returns:
        the thriftTransportProtocol value.
      • withThriftTransportProtocol

        public HiveLinkedService withThriftTransportProtocol​(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.
      • authenticationType

        public HiveAuthenticationType authenticationType()
        Get the authenticationType property: The authentication method used to access the Hive server.
        Returns:
        the authenticationType value.
      • withAuthenticationType

        public HiveLinkedService withAuthenticationType​(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.
      • serviceDiscoveryMode

        public Object serviceDiscoveryMode()
        Get the serviceDiscoveryMode property: true to indicate using the ZooKeeper service, false not.
        Returns:
        the serviceDiscoveryMode value.
      • withServiceDiscoveryMode

        public HiveLinkedService withServiceDiscoveryMode​(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.
      • zooKeeperNameSpace

        public Object zooKeeperNameSpace()
        Get the zooKeeperNameSpace property: The namespace on ZooKeeper under which Hive Server 2 nodes are added.
        Returns:
        the zooKeeperNameSpace value.
      • withZooKeeperNameSpace

        public HiveLinkedService withZooKeeperNameSpace​(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.
      • useNativeQuery

        public Object useNativeQuery()
        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.
      • withUseNativeQuery

        public HiveLinkedService withUseNativeQuery​(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.
      • username

        public Object username()
        Get the username property: The user name that you use to access Hive Server.
        Returns:
        the username value.
      • withUsername

        public HiveLinkedService withUsername​(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.
      • password

        public SecretBase password()
        Get the password property: The password corresponding to the user name that you provided in the Username field.
        Returns:
        the password value.
      • withPassword

        public HiveLinkedService withPassword​(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.
      • httpPath

        public Object httpPath()
        Get the httpPath property: The partial URL corresponding to the Hive server.
        Returns:
        the httpPath value.
      • withHttpPath

        public HiveLinkedService withHttpPath​(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.
      • enableSsl

        public Object enableSsl()
        Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false.
        Returns:
        the enableSsl value.
      • withEnableSsl

        public HiveLinkedService withEnableSsl​(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.
      • trustedCertPath

        public Object trustedCertPath()
        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.
      • withTrustedCertPath

        public HiveLinkedService withTrustedCertPath​(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.
      • useSystemTrustStore

        public Object useSystemTrustStore()
        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.
      • withUseSystemTrustStore

        public HiveLinkedService withUseSystemTrustStore​(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.
      • allowHostnameCNMismatch

        public Object allowHostnameCNMismatch()
        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.
      • withAllowHostnameCNMismatch

        public HiveLinkedService withAllowHostnameCNMismatch​(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.
      • allowSelfSignedServerCert

        public Object allowSelfSignedServerCert()
        Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false.
        Returns:
        the allowSelfSignedServerCert value.
      • withAllowSelfSignedServerCert

        public HiveLinkedService withAllowSelfSignedServerCert​(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.
      • encryptedCredential

        public Object encryptedCredential()
        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.
      • withEncryptedCredential

        public HiveLinkedService withEncryptedCredential​(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.