| |
| |
| |
| |
| |
| <!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.gcp_dlp_hook — 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.gcp_function_hook" href="../gcp_function_hook/index.html" /> |
| <link rel="prev" title="airflow.contrib.hooks.gcp_dataproc_hook" href="../gcp_dataproc_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> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </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.5 |
| </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 Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../scheduler.html">Scheduling & 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">REST API Reference</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">Python 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> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../privacy_notice.html">Privacy Notice</a></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> »</li> |
| |
| <li><a href="../../../../index.html">Python API Reference</a> »</li> |
| |
| <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.gcp_dlp_hook</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../../_sources/_api/airflow/contrib/hooks/gcp_dlp_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.gcp_dlp_hook"> |
| <span id="airflow-contrib-hooks-gcp-dlp-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.gcp_dlp_hook" title="airflow.contrib.hooks.gcp_dlp_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.gcp_dlp_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.gcp_dlp_hook" title="Permalink to this headline">¶</a></h1> |
| <p><p>This module contains a CloudDLPHook |
| which allows you to connect to GCP Cloud DLP service.</p> |
| </p> |
| <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.gcp_dlp_hook.DLP_JOB_PATH_PATTERN"> |
| <code class="sig-prename descclassname">airflow.contrib.hooks.gcp_dlp_hook.</code><code class="sig-name descname">DLP_JOB_PATH_PATTERN</code><em class="property"> = ^projects/[^/]+/dlpJobs/(?P<job>.*?)$</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#DLP_JOB_PATH_PATTERN"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.DLP_JOB_PATH_PATTERN" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="data"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.TIME_TO_SLEEP_IN_SECONDS"> |
| <code class="sig-prename descclassname">airflow.contrib.hooks.gcp_dlp_hook.</code><code class="sig-name descname">TIME_TO_SLEEP_IN_SECONDS</code><em class="property"> = 1</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#TIME_TO_SLEEP_IN_SECONDS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.TIME_TO_SLEEP_IN_SECONDS" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.gcp_dlp_hook.</code><code class="sig-name descname">CloudDLPHook</code><span class="sig-paren">(</span><em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../gcp_api_base_hook/index.html#airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook" title="airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook</span></code></a></p> |
| <p>Hook for Google Cloud Data Loss Prevention (DLP) APIs. |
| Cloud DLP allows clients to detect the presence of Personally Identifiable |
| Information (PII) and other privacy-sensitive data in user-supplied, |
| unstructured data streams, like text blocks or images. The service also |
| includes methods for sensitive data redaction and scheduling of data scans |
| on Google Cloud Platform based data sets.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>gcp_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The connection ID to use when fetching connection info.</p></li> |
| <li><p><strong>delegate_to</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The account to impersonate, if any. |
| For this to work, the service account making the request must have |
| domain-wide delegation enabled.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_conn"> |
| <code class="sig-name descname">get_conn</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/gcp_dlp_hook.html#CloudDLPHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_conn" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Provides a client for interacting with the Cloud DLP API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>GCP Cloud DLP API Client</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/api.html#google.cloud.dlp_v2.DlpServiceClient" title="(in google-cloud)">google.cloud.dlp_v2.DlpServiceClient</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.cancel_dlp_job"> |
| <code class="sig-name descname">cancel_dlp_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">dlp_job_id</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.cancel_dlp_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.cancel_dlp_job" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Starts asynchronous cancellation on a long-running DLP job.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dlp_job_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – ID of the DLP job resource to be cancelled.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default project_id |
| from the GCP connection is used.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_deidentify_template"> |
| <code class="sig-name descname">create_deidentify_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">deidentify_template=None</em>, <em class="sig-param">template_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.create_deidentify_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_deidentify_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a deidentify template for re-using frequently used configuration for |
| de-identifying content, images, and storage.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>deidentify_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyTemplate" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.DeidentifyTemplate</em></a>) – (Optional) The deidentify template to create.</p></li> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The template ID.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.DeidentifyTemplate</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_dlp_job"> |
| <code class="sig-name descname">create_dlp_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">inspect_job=None</em>, <em class="sig-param">risk_job=None</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em>, <em class="sig-param">wait_until_finished=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.create_dlp_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_dlp_job" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new job to inspect storage or calculate risk metrics.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>inspect_job</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectJobConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectJobConfig</em></a>) – (Optional) The configuration for the inspect job.</p></li> |
| <li><p><strong>risk_job</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.RiskAnalysisJobConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.RiskAnalysisJobConfig</em></a>) – (Optional) The configuration for the risk job.</p></li> |
| <li><p><strong>job_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The job ID.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| <li><p><strong>wait_until_finished</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – (Optional) If true, it will keep polling the job state |
| until it is set to DONE.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DlpJob" title="(in google-cloud)">google.cloud.dlp_v2.types.DlpJob</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_inspect_template"> |
| <code class="sig-name descname">create_inspect_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">inspect_template=None</em>, <em class="sig-param">template_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.create_inspect_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_inspect_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates an inspect template for re-using frequently used configuration for |
| inspecting content, images, and storage.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>inspect_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectTemplate" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectTemplate</em></a>) – (Optional) The inspect template to create.</p></li> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The template ID.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.InspectTemplate</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_job_trigger"> |
| <code class="sig-name descname">create_job_trigger</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">job_trigger=None</em>, <em class="sig-param">trigger_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.create_job_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_job_trigger" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a job trigger to run DLP actions such as scanning storage for sensitive |
| information on a set schedule.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>job_trigger</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.JobTrigger" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.JobTrigger</em></a>) – (Optional) The job trigger to create.</p></li> |
| <li><p><strong>trigger_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The job trigger ID.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.JobTrigger" title="(in google-cloud)">google.cloud.dlp_v2.types.JobTrigger</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_stored_info_type"> |
| <code class="sig-name descname">create_stored_info_type</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">config=None</em>, <em class="sig-param">stored_info_type_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.create_stored_info_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_stored_info_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a pre-built stored info type to be used for inspection.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.StoredInfoTypeConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.StoredInfoTypeConfig</em></a>) – (Optional) The config for the stored info type.</p></li> |
| <li><p><strong>stored_info_type_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The stored info type ID.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.StoredInfoType" title="(in google-cloud)">google.cloud.dlp_v2.types.StoredInfoType</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.deidentify_content"> |
| <code class="sig-name descname">deidentify_content</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">deidentify_config=None</em>, <em class="sig-param">inspect_config=None</em>, <em class="sig-param">item=None</em>, <em class="sig-param">inspect_template_name=None</em>, <em class="sig-param">deidentify_template_name=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.deidentify_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.deidentify_content" title="Permalink to this definition">¶</a></dt> |
| <dd><p>De-identifies potentially sensitive info from a content item. This method has limits |
| on input size and output size.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>deidentify_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.DeidentifyConfig</em></a>) – (Optional) Configuration for the de-identification of the |
| content item. Items specified here will override the template referenced by the |
| deidentify_template_name argument.</p></li> |
| <li><p><strong>inspect_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectConfig</em></a>) – (Optional) Configuration for the inspector. Items specified |
| here will override the template referenced by the inspect_template_name argument.</p></li> |
| <li><p><strong>item</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.ContentItem" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.ContentItem</em></a>) – (Optional) The item to de-identify. Will be treated as text.</p></li> |
| <li><p><strong>inspect_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional template to use. Any configuration |
| directly specified in inspect_config will override those set in the template.</p></li> |
| <li><p><strong>deidentify_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional template to use. Any |
| configuration directly specified in deidentify_config will override those set |
| in the template.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyContentResponse" title="(in google-cloud)">google.cloud.dlp_v2.types.DeidentifyContentResponse</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_deidentify_template"> |
| <code class="sig-name descname">delete_deidentify_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">template_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.delete_deidentify_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_deidentify_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes a deidentify template.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of deidentify template to be deleted.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_dlp_job"> |
| <code class="sig-name descname">delete_dlp_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">dlp_job_id</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.delete_dlp_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_dlp_job" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes a long-running DLP job. This method indicates that the client is no longer |
| interested in the DLP job result. The job will be cancelled if possible.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dlp_job_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the DLP job resource to be cancelled.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_inspect_template"> |
| <code class="sig-name descname">delete_inspect_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">template_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.delete_inspect_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_inspect_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes an inspect template.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the inspect template to be deleted.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_job_trigger"> |
| <code class="sig-name descname">delete_job_trigger</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job_trigger_id</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.delete_job_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_job_trigger" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes a job trigger.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>job_trigger_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the DLP job trigger to be deleted.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_stored_info_type"> |
| <code class="sig-name descname">delete_stored_info_type</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">stored_info_type_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.delete_stored_info_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_stored_info_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes a stored info type.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>stored_info_type_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the stored info type to be deleted.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_deidentify_template"> |
| <code class="sig-name descname">get_deidentify_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">template_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.get_deidentify_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_deidentify_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets a deidentify template.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of deidentify template to be read.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.DeidentifyTemplate</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_dlp_job"> |
| <code class="sig-name descname">get_dlp_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">dlp_job_id</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.get_dlp_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_dlp_job" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the latest state of a long-running Dlp Job.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dlp_job_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the DLP job resource to be read.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DlpJob" title="(in google-cloud)">google.cloud.dlp_v2.types.DlpJob</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_inspect_template"> |
| <code class="sig-name descname">get_inspect_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">template_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.get_inspect_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_inspect_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets an inspect template.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of inspect template to be read.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.InspectTemplate</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_job_trigger"> |
| <code class="sig-name descname">get_job_trigger</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job_trigger_id</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.get_job_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_job_trigger" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets a DLP job trigger.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>job_trigger_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the DLP job trigger to be read.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.JobTrigger" title="(in google-cloud)">google.cloud.dlp_v2.types.JobTrigger</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_stored_info_type"> |
| <code class="sig-name descname">get_stored_info_type</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">stored_info_type_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.get_stored_info_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_stored_info_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets a stored info type.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>stored_info_type_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the stored info type to be read.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.StoredInfoType" title="(in google-cloud)">google.cloud.dlp_v2.types.StoredInfoType</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.inspect_content"> |
| <code class="sig-name descname">inspect_content</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">inspect_config=None</em>, <em class="sig-param">item=None</em>, <em class="sig-param">inspect_template_name=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.inspect_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.inspect_content" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Finds potentially sensitive info in content. This method has limits on input size, |
| processing time, and output size.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>inspect_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectConfig</em></a>) – (Optional) Configuration for the inspector. Items specified |
| here will override the template referenced by the inspect_template_name argument.</p></li> |
| <li><p><strong>item</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.ContentItem" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.ContentItem</em></a>) – (Optional) The item to de-identify. Will be treated as text.</p></li> |
| <li><p><strong>inspect_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional template to use. Any configuration |
| directly specified in inspect_config will override those set in the template.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectContentResponse" title="(in google-cloud)">google.cloud.dlp_v2.types.InspectContentResponse</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_deidentify_templates"> |
| <code class="sig-name descname">list_deidentify_templates</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">order_by=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.list_deidentify_templates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_deidentify_templates" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Lists deidentify templates.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>page_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Optional) The maximum number of resources contained in the |
| underlying API response.</p></li> |
| <li><p><strong>order_by</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional comma separated list of fields to order by, |
| followed by asc or desc postfix.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.DeidentifyTemplate</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_dlp_jobs"> |
| <code class="sig-name descname">list_dlp_jobs</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">results_filter=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">job_type=None</em>, <em class="sig-param">order_by=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.list_dlp_jobs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_dlp_jobs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Lists DLP jobs that match the specified filter in the request.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>results_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Filter used to specify a subset of results.</p></li> |
| <li><p><strong>page_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Optional) The maximum number of resources contained in the |
| underlying API response.</p></li> |
| <li><p><strong>job_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The type of job.</p></li> |
| <li><p><strong>order_by</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional comma separated list of fields to order by, |
| followed by asc or desc postfix.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DlpJob" title="(in google-cloud)">google.cloud.dlp_v2.types.DlpJob</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_info_types"> |
| <code class="sig-name descname">list_info_types</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">language_code=None</em>, <em class="sig-param">results_filter=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.list_info_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_info_types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of the sensitive information types that the DLP API supports.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>language_code</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional BCP-47 language code for localized info |
| type friendly names. If omitted, or if localized strings are not available, |
| en-US strings will be returned.</p></li> |
| <li><p><strong>results_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Filter used to specify a subset of results.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.ListInfoTypesResponse" title="(in google-cloud)">google.cloud.dlp_v2.types.ListInfoTypesResponse</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_inspect_templates"> |
| <code class="sig-name descname">list_inspect_templates</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">order_by=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.list_inspect_templates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_inspect_templates" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Lists inspect templates.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>page_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Optional) The maximum number of resources contained in the |
| underlying API response.</p></li> |
| <li><p><strong>order_by</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional comma separated list of fields to order by, |
| followed by asc or desc postfix.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.InspectTemplate</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_job_triggers"> |
| <code class="sig-name descname">list_job_triggers</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">order_by=None</em>, <em class="sig-param">results_filter=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.list_job_triggers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_job_triggers" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Lists job triggers.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>page_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Optional) The maximum number of resources contained in the |
| underlying API response.</p></li> |
| <li><p><strong>order_by</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional comma separated list of fields to order by, |
| followed by asc or desc postfix.</p></li> |
| <li><p><strong>results_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Filter used to specify a subset of results.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.JobTrigger" title="(in google-cloud)">google.cloud.dlp_v2.types.JobTrigger</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_stored_info_types"> |
| <code class="sig-name descname">list_stored_info_types</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">order_by=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.list_stored_info_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_stored_info_types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Lists stored info types.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>page_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Optional) The maximum number of resources contained in the |
| underlying API response.</p></li> |
| <li><p><strong>order_by</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional comma separated list of fields to order by, |
| followed by asc or desc postfix.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.StoredInfoType" title="(in google-cloud)">google.cloud.dlp_v2.types.StoredInfoType</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.redact_image"> |
| <code class="sig-name descname">redact_image</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">inspect_config=None</em>, <em class="sig-param">image_redaction_configs=None</em>, <em class="sig-param">include_findings=None</em>, <em class="sig-param">byte_item=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.redact_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.redact_image" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Redacts potentially sensitive info from an image. This method has limits on |
| input size, processing time, and output size.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>inspect_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectConfig</em></a>) – (Optional) Configuration for the inspector. Items specified |
| here will override the template referenced by the inspect_template_name argument.</p></li> |
| <li><p><strong>image_redaction_configs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em>] or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a><em>[</em><em>google.cloud.dlp_v2.types.ImageRedactionConfig</em><em>]</em>) – (Optional) The configuration for specifying what |
| content to redact from images.</p></li> |
| <li><p><strong>include_findings</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – (Optional) Whether the response should include findings |
| along with the redacted image.</p></li> |
| <li><p><strong>byte_item</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.ByteContentItem" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.ByteContentItem</em></a>) – (Optional) The content must be PNG, JPEG, SVG or BMP.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.RedactImageResponse" title="(in google-cloud)">google.cloud.dlp_v2.types.RedactImageResponse</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.reidentify_content"> |
| <code class="sig-name descname">reidentify_content</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">reidentify_config=None</em>, <em class="sig-param">inspect_config=None</em>, <em class="sig-param">item=None</em>, <em class="sig-param">inspect_template_name=None</em>, <em class="sig-param">reidentify_template_name=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.reidentify_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.reidentify_content" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Re-identifies content that has been de-identified.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>reidentify_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.DeidentifyConfig</em></a>) – (Optional) Configuration for the re-identification of |
| the content item.</p></li> |
| <li><p><strong>inspect_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectConfig</em></a>) – (Optional) Configuration for the inspector.</p></li> |
| <li><p><strong>item</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.ContentItem" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.ContentItem</em></a>) – (Optional) The item to re-identify. Will be treated as text.</p></li> |
| <li><p><strong>inspect_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional template to use. Any configuration |
| directly specified in inspect_config will override those set in the template.</p></li> |
| <li><p><strong>reidentify_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Optional template to use. References an |
| instance of deidentify template. Any configuration directly specified in |
| reidentify_config or inspect_config will override those set in the template.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.ReidentifyContentResponse" title="(in google-cloud)">google.cloud.dlp_v2.types.ReidentifyContentResponse</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_deidentify_template"> |
| <code class="sig-name descname">update_deidentify_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">template_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">deidentify_template=None</em>, <em class="sig-param">update_mask=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.update_deidentify_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_deidentify_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the deidentify template.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of deidentify template to be updated.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>deidentify_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyTemplate" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.DeidentifyTemplate</em></a>) – New deidentify template value.</p></li> |
| <li><p><strong>update_mask</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.FieldMask" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.FieldMask</em></a>) – Mask to control which fields get updated.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.DeidentifyTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.DeidentifyTemplate</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_inspect_template"> |
| <code class="sig-name descname">update_inspect_template</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">template_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">inspect_template=None</em>, <em class="sig-param">update_mask=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.update_inspect_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_inspect_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the inspect template.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>template_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the inspect template to be updated.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>inspect_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectTemplate" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.InspectTemplate</em></a>) – New inspect template value.</p></li> |
| <li><p><strong>update_mask</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.FieldMask" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.FieldMask</em></a>) – Mask to control which fields get updated.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.InspectTemplate" title="(in google-cloud)">google.cloud.dlp_v2.types.InspectTemplate</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_job_trigger"> |
| <code class="sig-name descname">update_job_trigger</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job_trigger_id</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">job_trigger=None</em>, <em class="sig-param">update_mask=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.update_job_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_job_trigger" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates a job trigger.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>job_trigger_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the DLP job trigger to be updated.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. If set to None or missing, the default |
| project_id from the GCP connection is used.</p></li> |
| <li><p><strong>job_trigger</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.JobTrigger" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.JobTrigger</em></a>) – New job trigger value.</p></li> |
| <li><p><strong>update_mask</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.FieldMask" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.FieldMask</em></a>) – Mask to control which fields get updated.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.JobTrigger" title="(in google-cloud)">google.cloud.dlp_v2.types.JobTrigger</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_stored_info_type"> |
| <code class="sig-name descname">update_stored_info_type</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">stored_info_type_id</em>, <em class="sig-param">organization_id=None</em>, <em class="sig-param">project_id=None</em>, <em class="sig-param">config=None</em>, <em class="sig-param">update_mask=None</em>, <em class="sig-param">retry=None</em>, <em class="sig-param">timeout=None</em>, <em class="sig-param">metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_dlp_hook.html#CloudDLPHook.update_stored_info_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_stored_info_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the stored info type by creating a new version.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>stored_info_type_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The ID of the stored info type to be updated.</p></li> |
| <li><p><strong>organization_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) The organization ID. Required to set this |
| field if parent resource is an organzation.</p></li> |
| <li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) Google Cloud Platform project ID where the |
| DLP Instance exists. Only set this field if the parent resource is |
| a project instead of an organzation.</p></li> |
| <li><p><strong>config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.StoredInfoTypeConfig" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.StoredInfoTypeConfig</em></a>) – Updated configuration for the stored info type. If not provided, a new |
| version of the stored info type will be created with the existing configuration.</p></li> |
| <li><p><strong>update_mask</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em> or </em><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.FieldMask" title="(in google-cloud)"><em>google.cloud.dlp_v2.types.FieldMask</em></a>) – Mask to control which fields get updated.</p></li> |
| <li><p><strong>retry</strong> (<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/core/retry.html#google.api_core.retry.Retry" title="(in google-cloud)"><em>google.api_core.retry.Retry</em></a>) – (Optional) A retry object used to retry requests. |
| If None is specified, requests will not be retried.</p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – (Optional) The amount of time, in seconds, to wait for the request |
| to complete. Note that if retry is specified, the timeout applies to each |
| individual attempt.</p></li> |
| <li><p><strong>metadata</strong> (<em>sequence</em><em>[</em><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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – (Optional) Additional metadata that is provided to the method.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p><a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/dlp/gapic/v2/types.html#google.cloud.dlp_v2.types.StoredInfoType" title="(in google-cloud)">google.cloud.dlp_v2.types.StoredInfoType</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../gcp_function_hook/index.html" class="btn btn-neutral float-right" title="airflow.contrib.hooks.gcp_function_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../gcp_dataproc_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.gcp_dataproc_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>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
