Class AzureDatabricksLinkedServiceTypeProperties
java.lang.Object
com.azure.resourcemanager.datafactory.fluent.models.AzureDatabricksLinkedServiceTypeProperties
Azure Databricks linked service properties.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the accessToken property: Access token for databricks REST API.Get the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API.Get the credential property: The credential reference containing authentication information.domain()
Get the domain property: <REGION>.azuredatabricks.net, domain name of your Databricks deployment.Get the encryptedCredential property: The encrypted credential used for authentication.Get the existingClusterId property: The id of an existing interactive cluster that will be used for all runs of this activity.Get the instancePoolId property: The id of an existing instance pool that will be used for all runs of this activity.Get the newClusterCustomTags property: Additional tags for cluster resources.Get the newClusterDriverNodeType property: The driver node type for the new job cluster.Get the newClusterEnableElasticDisk property: Enable the elastic disk on the new cluster.Get the newClusterInitScripts property: User-defined initialization scripts for the new cluster.Get the newClusterLogDestination property: Specify a location to deliver Spark driver, worker, and event logs.Get the newClusterNodeType property: The node type of the new job cluster.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.Get the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.Get the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.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.policyId()
Get the policyId property: The policy id for limiting the ability to configure clusters based on a user defined set of rules.void
validate()
Validates the instance.withAccessToken
(SecretBase accessToken) Set the accessToken property: Access token for databricks REST API.withAuthentication
(Object authentication) Set the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API.withCredential
(CredentialReference credential) Set the credential property: The credential reference containing authentication information.withDomain
(Object domain) Set the domain property: <REGION>.azuredatabricks.net, domain name of your Databricks deployment.withEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.withExistingClusterId
(Object existingClusterId) Set the existingClusterId property: The id of an existing interactive cluster that will be used for all runs of this activity.withInstancePoolId
(Object instancePoolId) Set the instancePoolId property: The id of an existing instance pool that will be used for all runs of this activity.withNewClusterCustomTags
(Map<String, Object> newClusterCustomTags) Set the newClusterCustomTags property: Additional tags for cluster resources.withNewClusterDriverNodeType
(Object newClusterDriverNodeType) Set the newClusterDriverNodeType property: The driver node type for the new job cluster.withNewClusterEnableElasticDisk
(Object newClusterEnableElasticDisk) Set the newClusterEnableElasticDisk property: Enable the elastic disk on the new cluster.withNewClusterInitScripts
(Object newClusterInitScripts) Set the newClusterInitScripts property: User-defined initialization scripts for the new cluster.withNewClusterLogDestination
(Object newClusterLogDestination) Set the newClusterLogDestination property: Specify a location to deliver Spark driver, worker, and event logs.withNewClusterNodeType
(Object newClusterNodeType) Set the newClusterNodeType property: The node type of the new job cluster.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.withNewClusterSparkConf
(Map<String, Object> newClusterSparkConf) Set the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.withNewClusterSparkEnvVars
(Map<String, Object> newClusterSparkEnvVars) Set the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.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.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.withWorkspaceResourceId
(Object workspaceResourceId) Set the workspaceResourceId property: Workspace resource id for databricks REST API.Get the workspaceResourceId property: Workspace resource id for databricks REST API.
-
Constructor Details
-
AzureDatabricksLinkedServiceTypeProperties
public AzureDatabricksLinkedServiceTypeProperties()
-
-
Method Details
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
newClusterSparkConf
Get the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.- Returns:
- the newClusterSparkConf value.
-
withNewClusterSparkConf
public AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
newClusterSparkEnvVars
Get the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.- Returns:
- the newClusterSparkEnvVars value.
-
withNewClusterSparkEnvVars
public AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
newClusterCustomTags
Get the newClusterCustomTags property: Additional tags for cluster resources. This property is ignored in instance pool configurations.- Returns:
- the newClusterCustomTags value.
-
withNewClusterCustomTags
public AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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 AzureDatabricksLinkedServiceTypeProperties 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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
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
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 AzureDatabricksLinkedServiceTypeProperties object itself.
-
credential
Get the credential property: The credential reference containing authentication information.- Returns:
- the credential value.
-
withCredential
Set the credential property: The credential reference containing authentication information.- Parameters:
credential
- the credential value to set.- Returns:
- the AzureDatabricksLinkedServiceTypeProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-