Package com.azure.resourcemanager.datafactory.models

Class AzureDatabricksLinkedService

  • public final class AzureDatabricksLinkedService
extends LinkedService
    Azure Databricks linked service.

    • Constructor Detail

      • AzureDatabricksLinkedService

        public AzureDatabricksLinkedService()

    • Method Detail

      • withAnnotations

        public AzureDatabricksLinkedService 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.

      • domain

        public Object domain()
        Get the domain property: <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
        Returns:
        the domain value.

      • withDomain

        public AzureDatabricksLinkedService withDomain​(Object domain)
        Set the domain property: <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
        Parameters:
        domain - the domain value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • accessToken

        public SecretBase accessToken()
        Get the accessToken property: Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).
        Returns:
        the accessToken value.

      • withAccessToken

        public AzureDatabricksLinkedService withAccessToken​(SecretBase accessToken)
        Set the accessToken property: Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).
        Parameters:
        accessToken - the accessToken value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • authentication

        public Object authentication()
        Get the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
        Returns:
        the authentication value.

      • withAuthentication

        public AzureDatabricksLinkedService withAuthentication​(Object authentication)
        Set the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
        Parameters:
        authentication - the authentication value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • workspaceResourceId

        public Object workspaceResourceId()
        Get the workspaceResourceId property: Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
        Returns:
        the workspaceResourceId value.

      • withWorkspaceResourceId

        public AzureDatabricksLinkedService withWorkspaceResourceId​(Object workspaceResourceId)
        Set the workspaceResourceId property: Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
        Parameters:
        workspaceResourceId - the workspaceResourceId value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • existingClusterId

        public Object existingClusterId()
        Get the existingClusterId property: The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).
        Returns:
        the existingClusterId value.

      • withExistingClusterId

        public AzureDatabricksLinkedService withExistingClusterId​(Object existingClusterId)
        Set the existingClusterId property: The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).
        Parameters:
        existingClusterId - the existingClusterId value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • instancePoolId

        public Object instancePoolId()
        Get the instancePoolId property: The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).
        Returns:
        the instancePoolId value.

      • withInstancePoolId

        public AzureDatabricksLinkedService withInstancePoolId​(Object instancePoolId)
        Set the instancePoolId property: The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).
        Parameters:
        instancePoolId - the instancePoolId value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterVersion

        public Object newClusterVersion()
        Get the newClusterVersion property: If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).
        Returns:
        the newClusterVersion value.

      • withNewClusterVersion

        public AzureDatabricksLinkedService withNewClusterVersion​(Object newClusterVersion)
        Set the newClusterVersion property: If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).
        Parameters:
        newClusterVersion - the newClusterVersion value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterNumOfWorker

        public Object newClusterNumOfWorker()
        Get the newClusterNumOfWorker property: If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).
        Returns:
        the newClusterNumOfWorker value.

      • withNewClusterNumOfWorker

        public AzureDatabricksLinkedService withNewClusterNumOfWorker​(Object newClusterNumOfWorker)
        Set the newClusterNumOfWorker property: If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).
        Parameters:
        newClusterNumOfWorker - the newClusterNumOfWorker value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterNodeType

        public Object newClusterNodeType()
        Get the newClusterNodeType property: The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).
        Returns:
        the newClusterNodeType value.

      • withNewClusterNodeType

        public AzureDatabricksLinkedService withNewClusterNodeType​(Object newClusterNodeType)
        Set the newClusterNodeType property: The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).
        Parameters:
        newClusterNodeType - the newClusterNodeType value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterSparkConf

        public Map<String,​Object> newClusterSparkConf()
        Get the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.
        Returns:
        the newClusterSparkConf value.

      • withNewClusterSparkConf

        public AzureDatabricksLinkedService withNewClusterSparkConf​(Map<String,​Object> newClusterSparkConf)
        Set the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.
        Parameters:
        newClusterSparkConf - the newClusterSparkConf value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterSparkEnvVars

        public Map<String,​Object> newClusterSparkEnvVars()
        Get the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.
        Returns:
        the newClusterSparkEnvVars value.

      • withNewClusterSparkEnvVars

        public AzureDatabricksLinkedService withNewClusterSparkEnvVars​(Map<String,​Object> newClusterSparkEnvVars)
        Set the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.
        Parameters:
        newClusterSparkEnvVars - the newClusterSparkEnvVars value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterCustomTags

        public Map<String,​Object> newClusterCustomTags()
        Get the newClusterCustomTags property: Additional tags for cluster resources. This property is ignored in instance pool configurations.
        Returns:
        the newClusterCustomTags value.

      • withNewClusterCustomTags

        public AzureDatabricksLinkedService withNewClusterCustomTags​(Map<String,​Object> newClusterCustomTags)
        Set the newClusterCustomTags property: Additional tags for cluster resources. This property is ignored in instance pool configurations.
        Parameters:
        newClusterCustomTags - the newClusterCustomTags value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterLogDestination

        public Object newClusterLogDestination()
        Get the newClusterLogDestination property: Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).
        Returns:
        the newClusterLogDestination value.

      • withNewClusterLogDestination

        public AzureDatabricksLinkedService withNewClusterLogDestination​(Object newClusterLogDestination)
        Set the newClusterLogDestination property: Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).
        Parameters:
        newClusterLogDestination - the newClusterLogDestination value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterDriverNodeType

        public Object newClusterDriverNodeType()
        Get the newClusterDriverNodeType property: The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).
        Returns:
        the newClusterDriverNodeType value.

      • withNewClusterDriverNodeType

        public AzureDatabricksLinkedService withNewClusterDriverNodeType​(Object newClusterDriverNodeType)
        Set the newClusterDriverNodeType property: The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).
        Parameters:
        newClusterDriverNodeType - the newClusterDriverNodeType value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterInitScripts

        public Object newClusterInitScripts()
        Get the newClusterInitScripts property: User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).
        Returns:
        the newClusterInitScripts value.

      • withNewClusterInitScripts

        public AzureDatabricksLinkedService withNewClusterInitScripts​(Object newClusterInitScripts)
        Set the newClusterInitScripts property: User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).
        Parameters:
        newClusterInitScripts - the newClusterInitScripts value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • newClusterEnableElasticDisk

        public Object newClusterEnableElasticDisk()
        Get the newClusterEnableElasticDisk property: Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).
        Returns:
        the newClusterEnableElasticDisk value.

      • withNewClusterEnableElasticDisk

        public AzureDatabricksLinkedService withNewClusterEnableElasticDisk​(Object newClusterEnableElasticDisk)
        Set the newClusterEnableElasticDisk property: Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).
        Parameters:
        newClusterEnableElasticDisk - the newClusterEnableElasticDisk value to set.
        Returns:
        the AzureDatabricksLinkedService 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 AzureDatabricksLinkedService 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 AzureDatabricksLinkedService object itself.

      • policyId

        public Object policyId()
        Get the policyId property: The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).
        Returns:
        the policyId value.

      • withPolicyId

        public AzureDatabricksLinkedService withPolicyId​(Object policyId)
        Set the policyId property: The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).
        Parameters:
        policyId - the policyId value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.

      • credential

        public CredentialReference credential()
        Get the credential property: The credential reference containing authentication information.
        Returns:
        the credential value.

      • withCredential

        public AzureDatabricksLinkedService withCredential​(CredentialReference credential)
        Set the credential property: The credential reference containing authentication information.
        Parameters:
        credential - the credential value to set.
        Returns:
        the AzureDatabricksLinkedService object itself.