Share via

PhoenixLinkedService Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public class PhoenixLinkedService
extends LinkedService

Phoenix server linked service.

Constructor Summary

Constructor Description
PhoenixLinkedService()

Creates an instance of PhoenixLinkedService class.

Method Summary

Modifier and Type Method and Description
static PhoenixLinkedService fromJson(JsonReader jsonReader)

Reads an instance of PhoenixLinkedService from the JsonReader.
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.
PhoenixAuthenticationType getAuthenticationType()

Get the authenticationType property: The authentication mechanism used to connect to the Phoenix 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: The IP address or host name of the Phoenix server.
Object getHttpPath()

Get the httpPath property: The partial URL corresponding to the Phoenix server.
SecretBase getPassword()

Get the password property: The password corresponding to the user name.
Object getPort()

Get the port property: The TCP port that the Phoenix server uses to listen for client connections.
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.
String getType()

Get the type property: Type of linked service.
Object getUsername()

Get the username property: The user name used to connect to the Phoenix 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.
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.
PhoenixLinkedService setAllowSelfSignedServerCert(Object allowSelfSignedServerCert)

Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.
PhoenixLinkedService setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.
PhoenixLinkedService setAuthenticationType(PhoenixAuthenticationType authenticationType)

Set the authenticationType property: The authentication mechanism used to connect to the Phoenix server.
PhoenixLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.
PhoenixLinkedService setDescription(String description)

Set the description property: Linked service description.
PhoenixLinkedService setEnableSsl(Object enableSsl)

Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.
PhoenixLinkedService setEncryptedCredential(Object encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication.
PhoenixLinkedService setHost(Object host)

Set the host property: The IP address or host name of the Phoenix server.
PhoenixLinkedService setHttpPath(Object httpPath)

Set the httpPath property: The partial URL corresponding to the Phoenix server.
PhoenixLinkedService setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.
PhoenixLinkedService setPassword(SecretBase password)

Set the password property: The password corresponding to the user name.
PhoenixLinkedService setPort(Object port)

Set the port property: The TCP port that the Phoenix server uses to listen for client connections.
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.
PhoenixLinkedService setUsername(Object username)

Set the username property: The user name used to connect to the Phoenix server.
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.
PhoenixLinkedService setVersion(String version)

Set the version property: Version of the linked service.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from LinkedService

fromJson getAdditionalProperties getAnnotations getConnectVia getDescription getParameters getType getVersion setAdditionalProperties setAnnotations setConnectVia setDescription setParameters setVersion toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PhoenixLinkedService

public PhoenixLinkedService()

Creates an instance of PhoenixLinkedService class.

Method Details

fromJson

public static PhoenixLinkedService fromJson(JsonReader jsonReader)

Reads an instance of PhoenixLinkedService from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PhoenixLinkedService if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

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.

getAuthenticationType

public PhoenixAuthenticationType getAuthenticationType()

Get the authenticationType property: The authentication mechanism used to connect to the Phoenix server.

Returns:

the authenticationType value.

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.

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.

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.

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.

getPassword

public SecretBase getPassword()

Get the password property: The password corresponding to the user name.

Returns:

the password value.

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.

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.

getType

public String getType()

Get the type property: Type of linked service.

Overrides:

PhoenixLinkedService.getType()

Returns:

the type value.

getUsername

public Object getUsername()

Get the username property: The user name used to connect to the Phoenix server.

Returns:

the username value.

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.

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.

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.

setAnnotations

public PhoenixLinkedService setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

PhoenixLinkedService.setAnnotations(List<Object> annotations)

Parameters:

annotations

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.

setConnectVia

public PhoenixLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

PhoenixLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

setDescription

public PhoenixLinkedService setDescription(String description)

Set the description property: Linked service description.

Overrides:

PhoenixLinkedService.setDescription(String description)

Parameters:

description

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.

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.

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.

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.

setParameters

public PhoenixLinkedService setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.

Overrides:

PhoenixLinkedService.setParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

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.

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.

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.

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.

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.

setVersion

public PhoenixLinkedService setVersion(String version)

Set the version property: Version of the linked service.

Overrides:

PhoenixLinkedService.setVersion(String version)

Parameters:

version

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PhoenixLinkedService.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to