HiveLinkedService Class

Hive Server linked service.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

HiveLinkedService

Constructor

HiveLinkedService(*, host: object, authentication_type: str | HiveAuthenticationType, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None = None, port: object | None = None, server_type: str | HiveServerType | None = None, thrift_transport_protocol: str | HiveThriftTransportProtocol | None = None, service_discovery_mode: object | None = None, zoo_keeper_name_space: object | None = None, use_native_query: object | None = None, username: object | None = None, password: SecretBase | None = None, http_path: object | None = None, enable_ssl: object | None = None, trusted_cert_path: object | None = None, use_system_trust_store: object | None = None, allow_host_name_cn_mismatch: object | None = None, allow_self_signed_server_cert: object | None = None, encrypted_credential: object | None = None, **kwargs)

Parameters

Name	Description
additional_properties Required	dict[str, object] Unmatched properties from the message are deserialized to this collection.
type Required	str Required. Type of linked service.Constant filled by server.
connect_via Required	IntegrationRuntimeReference The integration runtime reference.
description Required	str Linked service description.
parameters Required	dict[str, ParameterSpecification] Parameters for linked service.
annotations Required	list[object] List of tags that can be used for describing the linked service.
host Required	object Required. IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).
port Required	object The TCP port that the Hive server uses to listen for client connections.
server_type Required	str or HiveServerType The type of Hive server. Possible values include: "HiveServer1", "HiveServer2", "HiveThriftServer".
thrift_transport_protocol Required	str or HiveThriftTransportProtocol The transport protocol to use in the Thrift layer. Possible values include: "Binary", "SASL", "HTTP ".
authentication_type Required	str or HiveAuthenticationType Required. The authentication method used to access the Hive server. Possible values include: "Anonymous", "Username", "UsernameAndPassword", "WindowsAzureHDInsightService".
service_discovery_mode Required	object true to indicate using the ZooKeeper service, false not.
zoo_keeper_name_space Required	object The namespace on ZooKeeper under which Hive Server 2 nodes are added.
use_native_query Required	object Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.
username Required	object The user name that you use to access Hive Server.
password Required	SecretBase The password corresponding to the user name that you provided in the Username field.
http_path Required	object The partial URL corresponding to the Hive server.
enable_ssl Required	object Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path Required	object 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.
use_system_trust_store Required	object Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
allow_host_name_cn_mismatch Required	object 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.
allow_self_signed_server_cert Required	object Specifies whether to allow self-signed certificates from the server. The default value is false.
encrypted_credential Required	object The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword-Only Parameters

Name	Description
host Required
authentication_type Required
additional_properties Required
connect_via Required
description Required
parameters Required
annotations Required
port Required
server_type Required
thrift_transport_protocol Required
service_discovery_mode Required
zoo_keeper_name_space Required
use_native_query Required
username Required
password Required
http_path Required
enable_ssl Required
trusted_cert_path Required
use_system_trust_store Required
allow_host_name_cn_mismatch Required
allow_self_signed_server_cert Required
encrypted_credential Required

Methods

as_dict	Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.
validate	Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. default value: None
key_extractors	default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error