Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _api / airflow / contrib / hooks / databricks_hook / index.html
blob: b58ea470e20055e7e53ece6ed557d9a1841838f3 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>airflow.contrib.hooks.databricks_hook &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../../search.html" />
<link rel="next" title="airflow.contrib.hooks.datadog_hook" href="../datadog_hook/index.html" />
<link rel="prev" title="airflow.contrib.hooks.cloudant_hook" href="../cloudant_hook/index.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../cli.html">Command Line Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../api.html">Experimental Rest API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../macros.html">Macros reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#operators">Operators</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#hooks-packages">Hooks packages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="../../../hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li>
<li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../../index.html">API Reference</a> &raquo;</li>
<li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> &raquo;</li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.databricks_hook</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../../_sources/_api/airflow/contrib/hooks/databricks_hook/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-airflow.contrib.hooks.databricks_hook">
<span id="airflow-contrib-hooks-databricks-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.databricks_hook" title="airflow.contrib.hooks.databricks_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.databricks_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.databricks_hook" title="Permalink to this headline"></a></h1>
<div class="section" id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline"></a></h2>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.RESTART_CLUSTER_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">RESTART_CLUSTER_ENDPOINT</code><em class="property"> = ['POST', 'api/2.0/clusters/restart']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RESTART_CLUSTER_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RESTART_CLUSTER_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.START_CLUSTER_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">START_CLUSTER_ENDPOINT</code><em class="property"> = ['POST', 'api/2.0/clusters/start']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#START_CLUSTER_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.START_CLUSTER_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.TERMINATE_CLUSTER_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">TERMINATE_CLUSTER_ENDPOINT</code><em class="property"> = ['POST', 'api/2.0/clusters/delete']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#TERMINATE_CLUSTER_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.TERMINATE_CLUSTER_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.RUN_NOW_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">RUN_NOW_ENDPOINT</code><em class="property"> = ['POST', 'api/2.0/jobs/run-now']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RUN_NOW_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RUN_NOW_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.SUBMIT_RUN_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">SUBMIT_RUN_ENDPOINT</code><em class="property"> = ['POST', 'api/2.0/jobs/runs/submit']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#SUBMIT_RUN_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.SUBMIT_RUN_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.GET_RUN_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">GET_RUN_ENDPOINT</code><em class="property"> = ['GET', 'api/2.0/jobs/runs/get']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#GET_RUN_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.GET_RUN_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.CANCEL_RUN_ENDPOINT">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">CANCEL_RUN_ENDPOINT</code><em class="property"> = ['POST', 'api/2.0/jobs/runs/cancel']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#CANCEL_RUN_ENDPOINT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.CANCEL_RUN_ENDPOINT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.USER_AGENT_HEADER">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">USER_AGENT_HEADER</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#USER_AGENT_HEADER"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.USER_AGENT_HEADER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook">
<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">DatabricksHook</code><span class="sig-paren">(</span><em class="sig-param">databricks_conn_id='databricks_default'</em>, <em class="sig-param">timeout_seconds=180</em>, <em class="sig-param">retry_limit=3</em>, <em class="sig-param">retry_delay=1.0</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="../../../hooks/base_hook/index.html#airflow.hooks.base_hook.BaseHook" title="airflow.hooks.base_hook.BaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.hooks.base_hook.BaseHook</span></code></a></p>
<p>Interact with Databricks.</p>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook._parse_host">
<em class="property">static </em><code class="sig-name descname">_parse_host</code><span class="sig-paren">(</span><em class="sig-param">host</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook._parse_host"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook._parse_host" title="Permalink to this definition"></a></dt>
<dd><p>The purpose of this function is to be robust to improper connections
settings provided by users, specifically in the host field.</p>
<p>For example – when users supply <code class="docutils literal notranslate"><span class="pre">https://xx.cloud.databricks.com</span></code> as the
host, we must strip out the protocol to get the host.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">h</span> <span class="o">=</span> <span class="n">DatabricksHook</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">h</span><span class="o">.</span><span class="n">_parse_host</span><span class="p">(</span><span class="s1">&#39;https://xx.cloud.databricks.com&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;xx.cloud.databricks.com&#39;</span>
</pre></div>
</div>
<p>In the case where users supply the correct <code class="docutils literal notranslate"><span class="pre">xx.cloud.databricks.com</span></code> as the
host, this function is a no-op.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">assert</span> <span class="n">h</span><span class="o">.</span><span class="n">_parse_host</span><span class="p">(</span><span class="s1">&#39;xx.cloud.databricks.com&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;xx.cloud.databricks.com&#39;</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook._do_api_call">
<code class="sig-name descname">_do_api_call</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">endpoint_info</em>, <em class="sig-param">json</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook._do_api_call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook._do_api_call" title="Permalink to this definition"></a></dt>
<dd><p>Utility function to perform an API call with retries</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>endpoint_info</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a><em>[</em><em>string</em><em>, </em><em>string</em><em>]</em>) – Tuple of method and endpoint</p></li>
<li><p><strong>json</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Parameters for this API call.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>If the api call returns a OK status code,
this function returns the response in JSON. Otherwise,
we throw an AirflowException.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook._log_request_error">
<code class="sig-name descname">_log_request_error</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">attempt_num</em>, <em class="sig-param">error</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook._log_request_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook._log_request_error" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.run_now">
<code class="sig-name descname">run_now</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">json</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.run_now"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.run_now" title="Permalink to this definition"></a></dt>
<dd><p>Utility function to call the <code class="docutils literal notranslate"><span class="pre">api/2.0/jobs/run-now</span></code> endpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>json</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – The data used in the body of the request to the <code class="docutils literal notranslate"><span class="pre">run-now</span></code> endpoint.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the run_id as a string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.submit_run">
<code class="sig-name descname">submit_run</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">json</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.submit_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.submit_run" title="Permalink to this definition"></a></dt>
<dd><p>Utility function to call the <code class="docutils literal notranslate"><span class="pre">api/2.0/jobs/runs/submit</span></code> endpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>json</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – The data used in the body of the request to the <code class="docutils literal notranslate"><span class="pre">submit</span></code> endpoint.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the run_id as a string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.get_run_page_url">
<code class="sig-name descname">get_run_page_url</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">run_id</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.get_run_page_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.get_run_page_url" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.get_run_state">
<code class="sig-name descname">get_run_state</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">run_id</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.get_run_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.get_run_state" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.cancel_run">
<code class="sig-name descname">cancel_run</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">run_id</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.cancel_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.cancel_run" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.restart_cluster">
<code class="sig-name descname">restart_cluster</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">json</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.restart_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.restart_cluster" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.start_cluster">
<code class="sig-name descname">start_cluster</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">json</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.start_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.start_cluster" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.DatabricksHook.terminate_cluster">
<code class="sig-name descname">terminate_cluster</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">json</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#DatabricksHook.terminate_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.DatabricksHook.terminate_cluster" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="airflow.contrib.hooks.databricks_hook._retryable_error">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">_retryable_error</code><span class="sig-paren">(</span><em class="sig-param">exception</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#_retryable_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook._retryable_error" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.databricks_hook.RUN_LIFE_CYCLE_STATES">
<code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">RUN_LIFE_CYCLE_STATES</code><em class="property"> = ['PENDING', 'RUNNING', 'TERMINATING', 'TERMINATED', 'SKIPPED', 'INTERNAL_ERROR']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RUN_LIFE_CYCLE_STATES"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RUN_LIFE_CYCLE_STATES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="airflow.contrib.hooks.databricks_hook.RunState">
<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">RunState</code><span class="sig-paren">(</span><em class="sig-param">life_cycle_state</em>, <em class="sig-param">result_state</em>, <em class="sig-param">state_message</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RunState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RunState" title="Permalink to this definition"></a></dt>
<dd><p>Utility class for the run state concept of Databricks runs.</p>
<dl class="attribute">
<dt id="airflow.contrib.hooks.databricks_hook.RunState.is_terminal">
<code class="sig-name descname">is_terminal</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RunState.is_terminal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RunState.is_terminal" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.databricks_hook.RunState.is_successful">
<code class="sig-name descname">is_successful</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RunState.is_successful"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RunState.is_successful" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.RunState.__eq__">
<code class="sig-name descname">__eq__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">other</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RunState.__eq__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RunState.__eq__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook.RunState.__repr__">
<code class="sig-name descname">__repr__</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#RunState.__repr__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook.RunState.__repr__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="airflow.contrib.hooks.databricks_hook._TokenAuth">
<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.databricks_hook.</code><code class="sig-name descname">_TokenAuth</code><span class="sig-paren">(</span><em class="sig-param">token</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#_TokenAuth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook._TokenAuth" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://2.python-requests.org//en/master/api/#requests.auth.AuthBase" title="(in Requests v2.22.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">requests.auth.AuthBase</span></code></a></p>
<p>Helper class for requests Auth field. AuthBase requires you to implement the __call__
magic function.</p>
<dl class="method">
<dt id="airflow.contrib.hooks.databricks_hook._TokenAuth.__call__">
<code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">r</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/databricks_hook.html#_TokenAuth.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.databricks_hook._TokenAuth.__call__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../datadog_hook/index.html" class="btn btn-neutral float-right" title="airflow.contrib.hooks.datadog_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../cloudant_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.cloudant_hook" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>