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

Class HDInsightOnDemandLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.HDInsightOnDemandLinkedService
public class HDInsightOnDemandLinkedService extends LinkedService
HDInsight ondemand linked service.

  • Constructor Details

    • HDInsightOnDemandLinkedService

      public HDInsightOnDemandLinkedService()

  • Method Details

    • getClusterSize

      public Object getClusterSize()
      Get the clusterSize property: Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
      Returns:
      the clusterSize value.

    • setClusterSize

      public HDInsightOnDemandLinkedService setClusterSize(Object clusterSize)
      Set the clusterSize property: Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
      Parameters:
      clusterSize - the clusterSize value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getTimeToLive

      public Object getTimeToLive()
      Get the timeToLive property: The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).
      Returns:
      the timeToLive value.

    • setTimeToLive

      public HDInsightOnDemandLinkedService setTimeToLive(Object timeToLive)
      Set the timeToLive property: The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).
      Parameters:
      timeToLive - the timeToLive value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getVersion

      public Object getVersion()
      Get the version property: Version of the HDInsight cluster.  Type: string (or Expression with resultType string).
      Returns:
      the version value.

    • setVersion

      public HDInsightOnDemandLinkedService setVersion(Object version)
      Set the version property: Version of the HDInsight cluster.  Type: string (or Expression with resultType string).
      Parameters:
      version - the version value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getLinkedServiceName

      public LinkedServiceReference getLinkedServiceName()
      Get the linkedServiceName property: Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
      Returns:
      the linkedServiceName value.

    • setLinkedServiceName

      public HDInsightOnDemandLinkedService setLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getHostSubscriptionId

      public Object getHostSubscriptionId()
      Get the hostSubscriptionId property: The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).
      Returns:
      the hostSubscriptionId value.

    • setHostSubscriptionId

      public HDInsightOnDemandLinkedService setHostSubscriptionId(Object hostSubscriptionId)
      Set the hostSubscriptionId property: The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).
      Parameters:
      hostSubscriptionId - the hostSubscriptionId value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getServicePrincipalId

      public Object getServicePrincipalId()
      Get the servicePrincipalId property: The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
      Returns:
      the servicePrincipalId value.

    • setServicePrincipalId

      public HDInsightOnDemandLinkedService setServicePrincipalId(Object servicePrincipalId)
      Set the servicePrincipalId property: The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
      Parameters:
      servicePrincipalId - the servicePrincipalId value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getServicePrincipalKey

      public SecretBase getServicePrincipalKey()
      Get the servicePrincipalKey property: The key for the service principal id.
      Returns:
      the servicePrincipalKey value.

    • setServicePrincipalKey

      public HDInsightOnDemandLinkedService setServicePrincipalKey(SecretBase servicePrincipalKey)
      Set the servicePrincipalKey property: The key for the service principal id.
      Parameters:
      servicePrincipalKey - the servicePrincipalKey value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getTenant

      public Object getTenant()
      Get the tenant property: The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
      Returns:
      the tenant value.

    • setTenant

      public HDInsightOnDemandLinkedService setTenant(Object tenant)
      Set the tenant property: The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
      Parameters:
      tenant - the tenant value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterResourceGroup

      public Object getClusterResourceGroup()
      Get the clusterResourceGroup property: The resource group where the cluster belongs. Type: string (or Expression with resultType string).
      Returns:
      the clusterResourceGroup value.

    • setClusterResourceGroup

      public HDInsightOnDemandLinkedService setClusterResourceGroup(Object clusterResourceGroup)
      Set the clusterResourceGroup property: The resource group where the cluster belongs. Type: string (or Expression with resultType string).
      Parameters:
      clusterResourceGroup - the clusterResourceGroup value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterNamePrefix

      public Object getClusterNamePrefix()
      Get the clusterNamePrefix property: The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
      Returns:
      the clusterNamePrefix value.

    • setClusterNamePrefix

      public HDInsightOnDemandLinkedService setClusterNamePrefix(Object clusterNamePrefix)
      Set the clusterNamePrefix property: The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
      Parameters:
      clusterNamePrefix - the clusterNamePrefix value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterUserName

      public Object getClusterUserName()
      Get the clusterUserName property: The username to access the cluster. Type: string (or Expression with resultType string).
      Returns:
      the clusterUserName value.

    • setClusterUserName

      public HDInsightOnDemandLinkedService setClusterUserName(Object clusterUserName)
      Set the clusterUserName property: The username to access the cluster. Type: string (or Expression with resultType string).
      Parameters:
      clusterUserName - the clusterUserName value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterPassword

      public SecretBase getClusterPassword()
      Get the clusterPassword property: The password to access the cluster.
      Returns:
      the clusterPassword value.

    • setClusterPassword

      public HDInsightOnDemandLinkedService setClusterPassword(SecretBase clusterPassword)
      Set the clusterPassword property: The password to access the cluster.
      Parameters:
      clusterPassword - the clusterPassword value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterSshUserName

      public Object getClusterSshUserName()
      Get the clusterSshUserName property: The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).
      Returns:
      the clusterSshUserName value.

    • setClusterSshUserName

      public HDInsightOnDemandLinkedService setClusterSshUserName(Object clusterSshUserName)
      Set the clusterSshUserName property: The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).
      Parameters:
      clusterSshUserName - the clusterSshUserName value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterSshPassword

      public SecretBase getClusterSshPassword()
      Get the clusterSshPassword property: The password to SSH remotely connect cluster’s node (for Linux).
      Returns:
      the clusterSshPassword value.

    • setClusterSshPassword

      public HDInsightOnDemandLinkedService setClusterSshPassword(SecretBase clusterSshPassword)
      Set the clusterSshPassword property: The password to SSH remotely connect cluster’s node (for Linux).
      Parameters:
      clusterSshPassword - the clusterSshPassword value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getAdditionalLinkedServiceNames

      public List<LinkedServiceReference> getAdditionalLinkedServiceNames()
      Get the additionalLinkedServiceNames property: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
      Returns:
      the additionalLinkedServiceNames value.

    • setAdditionalLinkedServiceNames

      public HDInsightOnDemandLinkedService setAdditionalLinkedServiceNames(List<LinkedServiceReference> additionalLinkedServiceNames)
      Set the additionalLinkedServiceNames property: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
      Parameters:
      additionalLinkedServiceNames - the additionalLinkedServiceNames value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getHcatalogLinkedServiceName

      public LinkedServiceReference getHcatalogLinkedServiceName()
      Get the hcatalogLinkedServiceName property: The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.
      Returns:
      the hcatalogLinkedServiceName value.

    • setHcatalogLinkedServiceName

      public HDInsightOnDemandLinkedService setHcatalogLinkedServiceName(LinkedServiceReference hcatalogLinkedServiceName)
      Set the hcatalogLinkedServiceName property: The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.
      Parameters:
      hcatalogLinkedServiceName - the hcatalogLinkedServiceName value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getClusterType

      public Object getClusterType()
      Get the clusterType property: The cluster type. Type: string (or Expression with resultType string).
      Returns:
      the clusterType value.

    • setClusterType

      public HDInsightOnDemandLinkedService setClusterType(Object clusterType)
      Set the clusterType property: The cluster type. Type: string (or Expression with resultType string).
      Parameters:
      clusterType - the clusterType value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getSparkVersion

      public Object getSparkVersion()
      Get the sparkVersion property: The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
      Returns:
      the sparkVersion value.

    • setSparkVersion

      public HDInsightOnDemandLinkedService setSparkVersion(Object sparkVersion)
      Set the sparkVersion property: The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
      Parameters:
      sparkVersion - the sparkVersion value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getCoreConfiguration

      public Object getCoreConfiguration()
      Get the coreConfiguration property: Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
      Returns:
      the coreConfiguration value.

    • setCoreConfiguration

      public HDInsightOnDemandLinkedService setCoreConfiguration(Object coreConfiguration)
      Set the coreConfiguration property: Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
      Parameters:
      coreConfiguration - the coreConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getHBaseConfiguration

      public Object getHBaseConfiguration()
      Get the hBaseConfiguration property: Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
      Returns:
      the hBaseConfiguration value.

    • setHBaseConfiguration

      public HDInsightOnDemandLinkedService setHBaseConfiguration(Object hBaseConfiguration)
      Set the hBaseConfiguration property: Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
      Parameters:
      hBaseConfiguration - the hBaseConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getHdfsConfiguration

      public Object getHdfsConfiguration()
      Get the hdfsConfiguration property: Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
      Returns:
      the hdfsConfiguration value.

    • setHdfsConfiguration

      public HDInsightOnDemandLinkedService setHdfsConfiguration(Object hdfsConfiguration)
      Set the hdfsConfiguration property: Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
      Parameters:
      hdfsConfiguration - the hdfsConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getHiveConfiguration

      public Object getHiveConfiguration()
      Get the hiveConfiguration property: Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
      Returns:
      the hiveConfiguration value.

    • setHiveConfiguration

      public HDInsightOnDemandLinkedService setHiveConfiguration(Object hiveConfiguration)
      Set the hiveConfiguration property: Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
      Parameters:
      hiveConfiguration - the hiveConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getMapReduceConfiguration

      public Object getMapReduceConfiguration()
      Get the mapReduceConfiguration property: Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
      Returns:
      the mapReduceConfiguration value.

    • setMapReduceConfiguration

      public HDInsightOnDemandLinkedService setMapReduceConfiguration(Object mapReduceConfiguration)
      Set the mapReduceConfiguration property: Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
      Parameters:
      mapReduceConfiguration - the mapReduceConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getOozieConfiguration

      public Object getOozieConfiguration()
      Get the oozieConfiguration property: Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
      Returns:
      the oozieConfiguration value.

    • setOozieConfiguration

      public HDInsightOnDemandLinkedService setOozieConfiguration(Object oozieConfiguration)
      Set the oozieConfiguration property: Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
      Parameters:
      oozieConfiguration - the oozieConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getStormConfiguration

      public Object getStormConfiguration()
      Get the stormConfiguration property: Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
      Returns:
      the stormConfiguration value.

    • setStormConfiguration

      public HDInsightOnDemandLinkedService setStormConfiguration(Object stormConfiguration)
      Set the stormConfiguration property: Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
      Parameters:
      stormConfiguration - the stormConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getYarnConfiguration

      public Object getYarnConfiguration()
      Get the yarnConfiguration property: Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
      Returns:
      the yarnConfiguration value.

    • setYarnConfiguration

      public HDInsightOnDemandLinkedService setYarnConfiguration(Object yarnConfiguration)
      Set the yarnConfiguration property: Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
      Parameters:
      yarnConfiguration - the yarnConfiguration value to set.
      Returns:
      the HDInsightOnDemandLinkedService 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 HDInsightOnDemandLinkedService 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 HDInsightOnDemandLinkedService object itself.

    • getHeadNodeSize

      public Object getHeadNodeSize()
      Get the headNodeSize property: Specifies the size of the head node for the HDInsight cluster.
      Returns:
      the headNodeSize value.

    • setHeadNodeSize

      public HDInsightOnDemandLinkedService setHeadNodeSize(Object headNodeSize)
      Set the headNodeSize property: Specifies the size of the head node for the HDInsight cluster.
      Parameters:
      headNodeSize - the headNodeSize value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getDataNodeSize

      public Object getDataNodeSize()
      Get the dataNodeSize property: Specifies the size of the data node for the HDInsight cluster.
      Returns:
      the dataNodeSize value.

    • setDataNodeSize

      public HDInsightOnDemandLinkedService setDataNodeSize(Object dataNodeSize)
      Set the dataNodeSize property: Specifies the size of the data node for the HDInsight cluster.
      Parameters:
      dataNodeSize - the dataNodeSize value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getZookeeperNodeSize

      public Object getZookeeperNodeSize()
      Get the zookeeperNodeSize property: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
      Returns:
      the zookeeperNodeSize value.

    • setZookeeperNodeSize

      public HDInsightOnDemandLinkedService setZookeeperNodeSize(Object zookeeperNodeSize)
      Set the zookeeperNodeSize property: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
      Parameters:
      zookeeperNodeSize - the zookeeperNodeSize value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getScriptActions

      public List<ScriptAction> getScriptActions()
      Get the scriptActions property: Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.
      Returns:
      the scriptActions value.

    • setScriptActions

      public HDInsightOnDemandLinkedService setScriptActions(List<ScriptAction> scriptActions)
      Set the scriptActions property: Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.
      Parameters:
      scriptActions - the scriptActions value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getVirtualNetworkId

      public Object getVirtualNetworkId()
      Get the virtualNetworkId property: The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
      Returns:
      the virtualNetworkId value.

    • setVirtualNetworkId

      public HDInsightOnDemandLinkedService setVirtualNetworkId(Object virtualNetworkId)
      Set the virtualNetworkId property: The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
      Parameters:
      virtualNetworkId - the virtualNetworkId value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • getSubnetName

      public Object getSubnetName()
      Get the subnetName property: The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).
      Returns:
      the subnetName value.

    • setSubnetName

      public HDInsightOnDemandLinkedService setSubnetName(Object subnetName)
      Set the subnetName property: The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).
      Parameters:
      subnetName - the subnetName value to set.
      Returns:
      the HDInsightOnDemandLinkedService object itself.

    • setConnectVia

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