Class PhoenixLinkedServiceTypeProperties


  • public final class PhoenixLinkedServiceTypeProperties
    extends Object
    Phoenix server linked service properties.
    • Constructor Detail

      • PhoenixLinkedServiceTypeProperties

        public PhoenixLinkedServiceTypeProperties()
    • Method Detail

      • host

        public Object host()
        Get the host property: The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).
        Returns:
        the host value.
      • withHost

        public PhoenixLinkedServiceTypeProperties withHost​(Object host)
        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 PhoenixLinkedServiceTypeProperties object itself.
      • port

        public Object port()
        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.
      • withPort

        public PhoenixLinkedServiceTypeProperties withPort​(Object port)
        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 PhoenixLinkedServiceTypeProperties object itself.
      • httpPath

        public Object httpPath()
        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.
      • withHttpPath

        public PhoenixLinkedServiceTypeProperties withHttpPath​(Object httpPath)
        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 PhoenixLinkedServiceTypeProperties object itself.
      • authenticationType

        public PhoenixAuthenticationType authenticationType()
        Get the authenticationType property: The authentication mechanism used to connect to the Phoenix server.
        Returns:
        the authenticationType value.
      • withAuthenticationType

        public PhoenixLinkedServiceTypeProperties withAuthenticationType​(PhoenixAuthenticationType authenticationType)
        Set the authenticationType property: The authentication mechanism used to connect to the Phoenix server.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the PhoenixLinkedServiceTypeProperties object itself.
      • username

        public Object username()
        Get the username property: The user name used to connect to the Phoenix server.
        Returns:
        the username value.
      • withUsername

        public PhoenixLinkedServiceTypeProperties withUsername​(Object username)
        Set the username property: The user name used to connect to the Phoenix server.
        Parameters:
        username - the username value to set.
        Returns:
        the PhoenixLinkedServiceTypeProperties object itself.
      • password

        public SecretBase password()
        Get the password property: The password corresponding to the user name.
        Returns:
        the password value.
      • withPassword

        public PhoenixLinkedServiceTypeProperties withPassword​(SecretBase password)
        Set the password property: The password corresponding to the user name.
        Parameters:
        password - the password value to set.
        Returns:
        the PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties 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 PhoenixLinkedServiceTypeProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.