Package com.azure.resourcemanager.datafactory.models

Class HDInsightOnDemandLinkedService

  • public final class HDInsightOnDemandLinkedService
extends LinkedService
    HDInsight ondemand linked service.

    • Constructor Detail

      • HDInsightOnDemandLinkedService

        public HDInsightOnDemandLinkedService()

    • Method Detail

      • withAnnotations

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

      • clusterSize

        public Object clusterSize()
        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.

      • withClusterSize

        public HDInsightOnDemandLinkedService withClusterSize​(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.

      • timeToLive

        public Object timeToLive()
        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.

      • withTimeToLive

        public HDInsightOnDemandLinkedService withTimeToLive​(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.

      • version

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

      • withVersion

        public HDInsightOnDemandLinkedService withVersion​(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.

      • linkedServiceName

        public LinkedServiceReference linkedServiceName()
        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.

      • withLinkedServiceName

        public HDInsightOnDemandLinkedService withLinkedServiceName​(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.

      • hostSubscriptionId

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

      • withHostSubscriptionId

        public HDInsightOnDemandLinkedService withHostSubscriptionId​(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.

      • servicePrincipalId

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

      • withServicePrincipalId

        public HDInsightOnDemandLinkedService withServicePrincipalId​(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.

      • servicePrincipalKey

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

      • withServicePrincipalKey

        public HDInsightOnDemandLinkedService withServicePrincipalKey​(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.

      • tenant

        public Object tenant()
        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.

      • withTenant

        public HDInsightOnDemandLinkedService withTenant​(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.

      • clusterResourceGroup

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

      • withClusterResourceGroup

        public HDInsightOnDemandLinkedService withClusterResourceGroup​(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.

      • clusterNamePrefix

        public Object clusterNamePrefix()
        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.

      • withClusterNamePrefix

        public HDInsightOnDemandLinkedService withClusterNamePrefix​(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.

      • clusterUsername

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

      • withClusterUsername

        public HDInsightOnDemandLinkedService withClusterUsername​(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.

      • clusterPassword

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

      • withClusterPassword

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

      • clusterSshUsername

        public Object clusterSshUsername()
        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.

      • withClusterSshUsername

        public HDInsightOnDemandLinkedService withClusterSshUsername​(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.

      • clusterSshPassword

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

      • withClusterSshPassword

        public HDInsightOnDemandLinkedService withClusterSshPassword​(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.

      • additionalLinkedServiceNames

        public List<LinkedServiceReference> additionalLinkedServiceNames()
        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.

      • withAdditionalLinkedServiceNames

        public HDInsightOnDemandLinkedService withAdditionalLinkedServiceNames​(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.

      • hcatalogLinkedServiceName

        public LinkedServiceReference hcatalogLinkedServiceName()
        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.

      • withHcatalogLinkedServiceName

        public HDInsightOnDemandLinkedService withHcatalogLinkedServiceName​(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.

      • clusterType

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

      • withClusterType

        public HDInsightOnDemandLinkedService withClusterType​(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.

      • sparkVersion

        public Object sparkVersion()
        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.

      • withSparkVersion

        public HDInsightOnDemandLinkedService withSparkVersion​(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.

      • coreConfiguration

        public Object coreConfiguration()
        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.

      • withCoreConfiguration

        public HDInsightOnDemandLinkedService withCoreConfiguration​(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.

      • hBaseConfiguration

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

      • withHBaseConfiguration

        public HDInsightOnDemandLinkedService withHBaseConfiguration​(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.

      • hdfsConfiguration

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

      • withHdfsConfiguration

        public HDInsightOnDemandLinkedService withHdfsConfiguration​(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.

      • hiveConfiguration

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

      • withHiveConfiguration

        public HDInsightOnDemandLinkedService withHiveConfiguration​(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.

      • mapReduceConfiguration

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

      • withMapReduceConfiguration

        public HDInsightOnDemandLinkedService withMapReduceConfiguration​(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.

      • oozieConfiguration

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

      • withOozieConfiguration

        public HDInsightOnDemandLinkedService withOozieConfiguration​(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.

      • stormConfiguration

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

      • withStormConfiguration

        public HDInsightOnDemandLinkedService withStormConfiguration​(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.

      • yarnConfiguration

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

      • withYarnConfiguration

        public HDInsightOnDemandLinkedService withYarnConfiguration​(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.

      • 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 HDInsightOnDemandLinkedService 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 HDInsightOnDemandLinkedService object itself.

      • headNodeSize

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

      • withHeadNodeSize

        public HDInsightOnDemandLinkedService withHeadNodeSize​(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.

      • dataNodeSize

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

      • withDataNodeSize

        public HDInsightOnDemandLinkedService withDataNodeSize​(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.

      • zookeeperNodeSize

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

      • withZookeeperNodeSize

        public HDInsightOnDemandLinkedService withZookeeperNodeSize​(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.

      • scriptActions

        public List<ScriptAction> scriptActions()
        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.

      • withScriptActions

        public HDInsightOnDemandLinkedService withScriptActions​(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.

      • virtualNetworkId

        public Object virtualNetworkId()
        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.

      • withVirtualNetworkId

        public HDInsightOnDemandLinkedService withVirtualNetworkId​(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.

      • subnetName

        public Object subnetName()
        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.

      • withSubnetName

        public HDInsightOnDemandLinkedService withSubnetName​(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.

      • credential

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

      • withCredential

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