Package com.azure.analytics.synapse.artifacts.models

Class PhoenixLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.PhoenixLinkedService
public class PhoenixLinkedService extends LinkedService
Phoenix server linked service.

  • Constructor Details

    • PhoenixLinkedService

      public PhoenixLinkedService()

  • Method Details

    • getHost

      public Object 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

      public PhoenixLinkedService setHost(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 PhoenixLinkedService object itself.

    • getPort

      public Object 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

      public PhoenixLinkedService setPort(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 PhoenixLinkedService object itself.

    • getHttpPath

      public Object 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

      public PhoenixLinkedService setHttpPath(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 PhoenixLinkedService object itself.

    • getAuthenticationType

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

    • setAuthenticationType

      public PhoenixLinkedService setAuthenticationType(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 PhoenixLinkedService object itself.

    • getUsername

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

    • setUsername

      public PhoenixLinkedService setUsername(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 PhoenixLinkedService object itself.

    • getPassword

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

    • setPassword

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

    • setConnectVia

      public PhoenixLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
      Set the connectVia property: The integration runtime reference.
      Overrides:
      setConnectVia in class LinkedService
      Parameters:
      connectVia - the connectVia value to set.
      Returns:
      the LinkedService object itself.

    • setDescription

      public PhoenixLinkedService setDescription(String description)
      Set the description property: Linked service description.
      Overrides:
      setDescription in class LinkedService
      Parameters:
      description - the description value to set.
      Returns:
      the LinkedService object itself.

    • setParameters

      public PhoenixLinkedService setParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for linked service.
      Overrides:
      setParameters in class LinkedService
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the LinkedService object itself.

    • setAnnotations

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