| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!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> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <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="stylesheet" href="../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.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.6 |
| </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> |
| <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="../../../../errors.html">Error Tracking</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"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API</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">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.gcp_dlp_hook</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.hooks.gcp_dlp_hook</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| |
| <span class="sd">"""</span> |
| <span class="sd">This module contains a CloudDLPHook</span> |
| <span class="sd">which allows you to connect to GCP Cloud DLP service.</span> |
| <span class="sd">"""</span> |
| |
| <span class="kn">import</span> <span class="nn">re</span> |
| <span class="kn">import</span> <span class="nn">time</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.dlp_v2</span> <span class="k">import</span> <span class="n">DlpServiceClient</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.dlp_v2.types</span> <span class="k">import</span> <span class="n">DlpJob</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| |
| <div class="viewcode-block" id="DLP_JOB_PATH_PATTERN"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.DLP_JOB_PATH_PATTERN">[docs]</a><span class="n">DLP_JOB_PATH_PATTERN</span> <span class="o">=</span> <span class="s1">'^projects/[^/]+/dlpJobs/(?P<job>.*?)$'</span></div> |
| <span class="c1"># Time to sleep between active checks of the operation results</span> |
| <div class="viewcode-block" id="TIME_TO_SLEEP_IN_SECONDS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.TIME_TO_SLEEP_IN_SECONDS">[docs]</a><span class="n">TIME_TO_SLEEP_IN_SECONDS</span> <span class="o">=</span> <span class="mi">1</span></div> |
| |
| |
| <span class="c1"># pylint: disable=R0904, C0302</span> |
| <div class="viewcode-block" id="CloudDLPHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook">[docs]</a><span class="k">class</span> <span class="nc">CloudDLPHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Hook for Google Cloud Data Loss Prevention (DLP) APIs.</span> |
| <span class="sd"> Cloud DLP allows clients to detect the presence of Personally Identifiable</span> |
| <span class="sd"> Information (PII) and other privacy-sensitive data in user-supplied,</span> |
| <span class="sd"> unstructured data streams, like text blocks or images. The service also</span> |
| <span class="sd"> includes methods for sensitive data redaction and scheduling of data scans</span> |
| <span class="sd"> on Google Cloud Platform based data sets.</span> |
| |
| <span class="sd"> :param gcp_conn_id: The connection ID to use when fetching connection info.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param delegate_to: The account to impersonate, if any.</span> |
| <span class="sd"> For this to work, the service account making the request must have</span> |
| <span class="sd"> domain-wide delegation enabled.</span> |
| <span class="sd"> :type delegate_to: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudDLPHook</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="CloudDLPHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Provides a client for interacting with the Cloud DLP API.</span> |
| |
| <span class="sd"> :return: GCP Cloud DLP API Client</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.DlpServiceClient</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="p">(</span><span class="n">credentials</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_credentials</span><span class="p">())</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.cancel_dlp_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.cancel_dlp_job">[docs]</a> <span class="k">def</span> <span class="nf">cancel_dlp_job</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">dlp_job_id</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Starts asynchronous cancellation on a long-running DLP job.</span> |
| |
| <span class="sd"> :param dlp_job_id: ID of the DLP job resource to be cancelled.</span> |
| <span class="sd"> :type dlp_job_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default project_id</span> |
| <span class="sd"> from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">dlp_job_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the DLP job resource to be cancelled."</span> |
| <span class="p">)</span> |
| |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">dlp_job_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">dlp_job_id</span><span class="p">)</span> |
| <span class="n">client</span><span class="o">.</span><span class="n">cancel_dlp_job</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.create_deidentify_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_deidentify_template">[docs]</a> <span class="k">def</span> <span class="nf">create_deidentify_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">deidentify_template</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a deidentify template for re-using frequently used configuration for</span> |
| <span class="sd"> de-identifying content, images, and storage.</span> |
| |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param deidentify_template: (Optional) The deidentify template to create.</span> |
| <span class="sd"> :type deidentify_template: dict or google.cloud.dlp_v2.types.DeidentifyTemplate</span> |
| <span class="sd"> :param template_id: (Optional) The template ID.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.DeidentifyTemplate</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">create_deidentify_template</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">deidentify_template</span><span class="o">=</span><span class="n">deidentify_template</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="o">=</span><span class="n">template_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.create_dlp_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_dlp_job">[docs]</a> <span class="k">def</span> <span class="nf">create_dlp_job</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_job</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">risk_job</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">job_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">wait_until_finished</span><span class="o">=</span><span class="kc">True</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a new job to inspect storage or calculate risk metrics.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param inspect_job: (Optional) The configuration for the inspect job.</span> |
| <span class="sd"> :type inspect_job: dict or google.cloud.dlp_v2.types.InspectJobConfig</span> |
| <span class="sd"> :param risk_job: (Optional) The configuration for the risk job.</span> |
| <span class="sd"> :type risk_job: dict or google.cloud.dlp_v2.types.RiskAnalysisJobConfig</span> |
| <span class="sd"> :param job_id: (Optional) The job ID.</span> |
| <span class="sd"> :type job_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :param wait_until_finished: (Optional) If true, it will keep polling the job state</span> |
| <span class="sd"> until it is set to DONE.</span> |
| <span class="sd"> :type wait_until_finished: bool</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.DlpJob</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="n">job</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_dlp_job</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">inspect_job</span><span class="o">=</span><span class="n">inspect_job</span><span class="p">,</span> |
| <span class="n">risk_job</span><span class="o">=</span><span class="n">risk_job</span><span class="p">,</span> |
| <span class="n">job_id</span><span class="o">=</span><span class="n">job_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">wait_until_finished</span><span class="p">:</span> |
| <span class="n">pattern</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">DLP_JOB_PATH_PATTERN</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span> |
| <span class="n">match</span> <span class="o">=</span> <span class="n">pattern</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">job</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| <span class="n">job_name</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()[</span><span class="s1">'job'</span><span class="p">]</span> |
| |
| <span class="k">while</span> <span class="n">wait_until_finished</span><span class="p">:</span> |
| <span class="n">job</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_dlp_job</span><span class="p">(</span> |
| <span class="n">dlp_job_id</span><span class="o">=</span><span class="n">job_name</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span> |
| <span class="s1">'DLP job </span><span class="si">{}</span><span class="s1"> state: </span><span class="si">{}</span><span class="s1">.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">job</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">DlpJob</span><span class="o">.</span><span class="n">JobState</span><span class="o">.</span><span class="n">Name</span><span class="p">(</span><span class="n">job</span><span class="o">.</span><span class="n">state</span><span class="p">)</span> |
| <span class="p">)</span> |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">job</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">DlpJob</span><span class="o">.</span><span class="n">JobState</span><span class="o">.</span><span class="n">DONE</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">job</span> |
| <span class="k">elif</span> <span class="n">job</span><span class="o">.</span><span class="n">state</span> <span class="ow">in</span> <span class="p">[</span><span class="n">DlpJob</span><span class="o">.</span><span class="n">JobState</span><span class="o">.</span><span class="n">PENDING</span><span class="p">,</span> |
| <span class="n">DlpJob</span><span class="o">.</span><span class="n">JobState</span><span class="o">.</span><span class="n">RUNNING</span><span class="p">,</span> |
| <span class="n">DlpJob</span><span class="o">.</span><span class="n">JobState</span><span class="o">.</span><span class="n">JOB_STATE_UNSPECIFIED</span><span class="p">]:</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">TIME_TO_SLEEP_IN_SECONDS</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'Stopped polling DLP job state. DLP job </span><span class="si">{}</span><span class="s1"> state: </span><span class="si">{}</span><span class="s1">.'</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">job</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">DlpJob</span><span class="o">.</span><span class="n">JobState</span><span class="o">.</span><span class="n">Name</span><span class="p">(</span><span class="n">job</span><span class="o">.</span><span class="n">state</span><span class="p">)</span> |
| <span class="p">)</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="n">job</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.create_inspect_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_inspect_template">[docs]</a> <span class="k">def</span> <span class="nf">create_inspect_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_template</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates an inspect template for re-using frequently used configuration for</span> |
| <span class="sd"> inspecting content, images, and storage.</span> |
| |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param inspect_template: (Optional) The inspect template to create.</span> |
| <span class="sd"> :type inspect_template: dict or google.cloud.dlp_v2.types.InspectTemplate</span> |
| <span class="sd"> :param template_id: (Optional) The template ID.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.InspectTemplate</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">create_inspect_template</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">inspect_template</span><span class="o">=</span><span class="n">inspect_template</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="o">=</span><span class="n">template_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.create_job_trigger"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_job_trigger">[docs]</a> <span class="k">def</span> <span class="nf">create_job_trigger</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">job_trigger</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">trigger_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a job trigger to run DLP actions such as scanning storage for sensitive</span> |
| <span class="sd"> information on a set schedule.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param job_trigger: (Optional) The job trigger to create.</span> |
| <span class="sd"> :type job_trigger: dict or google.cloud.dlp_v2.types.JobTrigger</span> |
| <span class="sd"> :param trigger_id: (Optional) The job trigger ID.</span> |
| <span class="sd"> :type trigger_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.JobTrigger</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">create_job_trigger</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">job_trigger</span><span class="o">=</span><span class="n">job_trigger</span><span class="p">,</span> |
| <span class="n">trigger_id</span><span class="o">=</span><span class="n">trigger_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.create_stored_info_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.create_stored_info_type">[docs]</a> <span class="k">def</span> <span class="nf">create_stored_info_type</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a pre-built stored info type to be used for inspection.</span> |
| |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param config: (Optional) The config for the stored info type.</span> |
| <span class="sd"> :type config: dict or google.cloud.dlp_v2.types.StoredInfoTypeConfig</span> |
| <span class="sd"> :param stored_info_type_id: (Optional) The stored info type ID.</span> |
| <span class="sd"> :type stored_info_type_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.StoredInfoType</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">create_stored_info_type</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span><span class="o">=</span><span class="n">stored_info_type_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.deidentify_content"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.deidentify_content">[docs]</a> <span class="k">def</span> <span class="nf">deidentify_content</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">deidentify_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">item</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_template_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">deidentify_template_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> De-identifies potentially sensitive info from a content item. This method has limits</span> |
| <span class="sd"> on input size and output size.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param deidentify_config: (Optional) Configuration for the de-identification of the</span> |
| <span class="sd"> content item. Items specified here will override the template referenced by the</span> |
| <span class="sd"> deidentify_template_name argument.</span> |
| <span class="sd"> :type deidentify_config: dict or google.cloud.dlp_v2.types.DeidentifyConfig</span> |
| <span class="sd"> :param inspect_config: (Optional) Configuration for the inspector. Items specified</span> |
| <span class="sd"> here will override the template referenced by the inspect_template_name argument.</span> |
| <span class="sd"> :type inspect_config: dict or google.cloud.dlp_v2.types.InspectConfig</span> |
| <span class="sd"> :param item: (Optional) The item to de-identify. Will be treated as text.</span> |
| <span class="sd"> :type item: dict or google.cloud.dlp_v2.types.ContentItem</span> |
| <span class="sd"> :param inspect_template_name: (Optional) Optional template to use. Any configuration</span> |
| <span class="sd"> directly specified in inspect_config will override those set in the template.</span> |
| <span class="sd"> :type inspect_template_name: str</span> |
| <span class="sd"> :param deidentify_template_name: (Optional) Optional template to use. Any</span> |
| <span class="sd"> configuration directly specified in deidentify_config will override those set</span> |
| <span class="sd"> in the template.</span> |
| <span class="sd"> :type deidentify_template_name: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.DeidentifyContentResponse</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">deidentify_content</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">deidentify_config</span><span class="o">=</span><span class="n">deidentify_config</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="n">inspect_config</span><span class="p">,</span> |
| <span class="n">item</span><span class="o">=</span><span class="n">item</span><span class="p">,</span> |
| <span class="n">inspect_template_name</span><span class="o">=</span><span class="n">inspect_template_name</span><span class="p">,</span> |
| <span class="n">deidentify_template_name</span><span class="o">=</span><span class="n">deidentify_template_name</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.delete_deidentify_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_deidentify_template">[docs]</a> <span class="k">def</span> <span class="nf">delete_deidentify_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes a deidentify template.</span> |
| |
| <span class="sd"> :param template_id: The ID of deidentify template to be deleted.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">template_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of deidentify template to be deleted."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_deidentify_template_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_deidentify_template_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_deidentify_template</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.delete_dlp_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_dlp_job">[docs]</a> <span class="k">def</span> <span class="nf">delete_dlp_job</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">dlp_job_id</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes a long-running DLP job. This method indicates that the client is no longer</span> |
| <span class="sd"> interested in the DLP job result. The job will be cancelled if possible.</span> |
| |
| <span class="sd"> :param dlp_job_id: The ID of the DLP job resource to be cancelled.</span> |
| <span class="sd"> :type dlp_job_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">dlp_job_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the DLP job resource to be cancelled."</span> |
| <span class="p">)</span> |
| |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">dlp_job_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">dlp_job_id</span><span class="p">)</span> |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_dlp_job</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.delete_inspect_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_inspect_template">[docs]</a> <span class="k">def</span> <span class="nf">delete_inspect_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes an inspect template.</span> |
| |
| <span class="sd"> :param template_id: The ID of the inspect template to be deleted.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">template_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the inspect template to be deleted."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_inspect_template_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_inspect_template_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_inspect_template</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.delete_job_trigger"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_job_trigger">[docs]</a> <span class="k">def</span> <span class="nf">delete_job_trigger</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">job_trigger_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes a job trigger.</span> |
| |
| <span class="sd"> :param job_trigger_id: The ID of the DLP job trigger to be deleted.</span> |
| <span class="sd"> :type job_trigger_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">job_trigger_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the DLP job trigger to be deleted."</span> |
| <span class="p">)</span> |
| |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_job_trigger_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">job_trigger_id</span><span class="p">)</span> |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_job_trigger</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.delete_stored_info_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.delete_stored_info_type">[docs]</a> <span class="k">def</span> <span class="nf">delete_stored_info_type</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes a stored info type.</span> |
| |
| <span class="sd"> :param stored_info_type_id: The ID of the stored info type to be deleted.</span> |
| <span class="sd"> :type stored_info_type_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">stored_info_type_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the stored info type to be deleted."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_stored_info_type_path</span><span class="p">(</span> |
| <span class="n">organization_id</span><span class="p">,</span> <span class="n">stored_info_type_id</span> |
| <span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_stored_info_type_path</span><span class="p">(</span> |
| <span class="n">project_id</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span> |
| <span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_stored_info_type</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.get_deidentify_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_deidentify_template">[docs]</a> <span class="k">def</span> <span class="nf">get_deidentify_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets a deidentify template.</span> |
| |
| <span class="sd"> :param template_id: The ID of deidentify template to be read.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.DeidentifyTemplate</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">template_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the deidentify template to be read."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_deidentify_template_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_deidentify_template_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">get_deidentify_template</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.get_dlp_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_dlp_job">[docs]</a> <span class="k">def</span> <span class="nf">get_dlp_job</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">dlp_job_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets the latest state of a long-running Dlp Job.</span> |
| |
| <span class="sd"> :param dlp_job_id: The ID of the DLP job resource to be read.</span> |
| <span class="sd"> :type dlp_job_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.DlpJob</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">dlp_job_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the DLP job resource to be read."</span> |
| <span class="p">)</span> |
| |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">dlp_job_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">dlp_job_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">get_dlp_job</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.get_inspect_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_inspect_template">[docs]</a> <span class="k">def</span> <span class="nf">get_inspect_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets an inspect template.</span> |
| |
| <span class="sd"> :param template_id: The ID of inspect template to be read.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.InspectTemplate</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">template_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the inspect template to be read."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_inspect_template_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_inspect_template_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">get_inspect_template</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.get_job_trigger"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_job_trigger">[docs]</a> <span class="k">def</span> <span class="nf">get_job_trigger</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">job_trigger_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets a DLP job trigger.</span> |
| |
| <span class="sd"> :param job_trigger_id: The ID of the DLP job trigger to be read.</span> |
| <span class="sd"> :type job_trigger_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.JobTrigger</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">job_trigger_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the DLP job trigger to be read."</span> |
| <span class="p">)</span> |
| |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_job_trigger_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">job_trigger_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">get_job_trigger</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.get_stored_info_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.get_stored_info_type">[docs]</a> <span class="k">def</span> <span class="nf">get_stored_info_type</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets a stored info type.</span> |
| |
| <span class="sd"> :param stored_info_type_id: The ID of the stored info type to be read.</span> |
| <span class="sd"> :type stored_info_type_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.StoredInfoType</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">stored_info_type_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the stored info type to be read."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_stored_info_type_path</span><span class="p">(</span> |
| <span class="n">organization_id</span><span class="p">,</span> <span class="n">stored_info_type_id</span> |
| <span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_stored_info_type_path</span><span class="p">(</span> |
| <span class="n">project_id</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span> |
| <span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">get_stored_info_type</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.inspect_content"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.inspect_content">[docs]</a> <span class="k">def</span> <span class="nf">inspect_content</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">item</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_template_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Finds potentially sensitive info in content. This method has limits on input size,</span> |
| <span class="sd"> processing time, and output size.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param inspect_config: (Optional) Configuration for the inspector. Items specified</span> |
| <span class="sd"> here will override the template referenced by the inspect_template_name argument.</span> |
| <span class="sd"> :type inspect_config: dict or google.cloud.dlp_v2.types.InspectConfig</span> |
| <span class="sd"> :param item: (Optional) The item to de-identify. Will be treated as text.</span> |
| <span class="sd"> :type item: dict or google.cloud.dlp_v2.types.ContentItem</span> |
| <span class="sd"> :param inspect_template_name: (Optional) Optional template to use. Any configuration</span> |
| <span class="sd"> directly specified in inspect_config will override those set in the template.</span> |
| <span class="sd"> :type inspect_template_name: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.InspectContentResponse</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">inspect_content</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="n">inspect_config</span><span class="p">,</span> |
| <span class="n">item</span><span class="o">=</span><span class="n">item</span><span class="p">,</span> |
| <span class="n">inspect_template_name</span><span class="o">=</span><span class="n">inspect_template_name</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.list_deidentify_templates"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_deidentify_templates">[docs]</a> <span class="k">def</span> <span class="nf">list_deidentify_templates</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lists deidentify templates.</span> |
| |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param page_size: (Optional) The maximum number of resources contained in the</span> |
| <span class="sd"> underlying API response.</span> |
| <span class="sd"> :type page_size: int</span> |
| <span class="sd"> :param order_by: (Optional) Optional comma separated list of fields to order by,</span> |
| <span class="sd"> followed by asc or desc postfix.</span> |
| <span class="sd"> :type order_by: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: list[google.cloud.dlp_v2.types.DeidentifyTemplate]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="n">results</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">list_deidentify_templates</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="n">page_size</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="n">order_by</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.list_dlp_jobs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_dlp_jobs">[docs]</a> <span class="k">def</span> <span class="nf">list_dlp_jobs</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">results_filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">job_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lists DLP jobs that match the specified filter in the request.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param results_filter: (Optional) Filter used to specify a subset of results.</span> |
| <span class="sd"> :type results_filter: str</span> |
| <span class="sd"> :param page_size: (Optional) The maximum number of resources contained in the</span> |
| <span class="sd"> underlying API response.</span> |
| <span class="sd"> :type page_size: int</span> |
| <span class="sd"> :param job_type: (Optional) The type of job.</span> |
| <span class="sd"> :type job_type: str</span> |
| <span class="sd"> :param order_by: (Optional) Optional comma separated list of fields to order by,</span> |
| <span class="sd"> followed by asc or desc postfix.</span> |
| <span class="sd"> :type order_by: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: list[google.cloud.dlp_v2.types.DlpJob]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">list_dlp_jobs</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">filter_</span><span class="o">=</span><span class="n">results_filter</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="n">page_size</span><span class="p">,</span> |
| <span class="n">type_</span><span class="o">=</span><span class="n">job_type</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="n">order_by</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.list_info_types"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_info_types">[docs]</a> <span class="k">def</span> <span class="nf">list_info_types</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">language_code</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">results_filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a list of the sensitive information types that the DLP API supports.</span> |
| |
| <span class="sd"> :param language_code: (Optional) Optional BCP-47 language code for localized info</span> |
| <span class="sd"> type friendly names. If omitted, or if localized strings are not available,</span> |
| <span class="sd"> en-US strings will be returned.</span> |
| <span class="sd"> :type language_code: str</span> |
| <span class="sd"> :param results_filter: (Optional) Filter used to specify a subset of results.</span> |
| <span class="sd"> :type results_filter: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.ListInfoTypesResponse</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">list_info_types</span><span class="p">(</span> |
| <span class="n">language_code</span><span class="o">=</span><span class="n">language_code</span><span class="p">,</span> |
| <span class="n">filter_</span><span class="o">=</span><span class="n">results_filter</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.list_inspect_templates"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_inspect_templates">[docs]</a> <span class="k">def</span> <span class="nf">list_inspect_templates</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lists inspect templates.</span> |
| |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param page_size: (Optional) The maximum number of resources contained in the</span> |
| <span class="sd"> underlying API response.</span> |
| <span class="sd"> :type page_size: int</span> |
| <span class="sd"> :param order_by: (Optional) Optional comma separated list of fields to order by,</span> |
| <span class="sd"> followed by asc or desc postfix.</span> |
| <span class="sd"> :type order_by: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: list[google.cloud.dlp_v2.types.InspectTemplate]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="n">results</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">list_inspect_templates</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="n">page_size</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="n">order_by</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.list_job_triggers"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_job_triggers">[docs]</a> <span class="k">def</span> <span class="nf">list_job_triggers</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">results_filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lists job triggers.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param page_size: (Optional) The maximum number of resources contained in the</span> |
| <span class="sd"> underlying API response.</span> |
| <span class="sd"> :type page_size: int</span> |
| <span class="sd"> :param order_by: (Optional) Optional comma separated list of fields to order by,</span> |
| <span class="sd"> followed by asc or desc postfix.</span> |
| <span class="sd"> :type order_by: str</span> |
| <span class="sd"> :param results_filter: (Optional) Filter used to specify a subset of results.</span> |
| <span class="sd"> :type results_filter: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: list[google.cloud.dlp_v2.types.JobTrigger]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">list_job_triggers</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="n">page_size</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="n">order_by</span><span class="p">,</span> |
| <span class="n">filter_</span><span class="o">=</span><span class="n">results_filter</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.list_stored_info_types"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.list_stored_info_types">[docs]</a> <span class="k">def</span> <span class="nf">list_stored_info_types</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lists stored info types.</span> |
| |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param page_size: (Optional) The maximum number of resources contained in the</span> |
| <span class="sd"> underlying API response.</span> |
| <span class="sd"> :type page_size: int</span> |
| <span class="sd"> :param order_by: (Optional) Optional comma separated list of fields to order by,</span> |
| <span class="sd"> followed by asc or desc postfix.</span> |
| <span class="sd"> :type order_by: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: list[google.cloud.dlp_v2.types.StoredInfoType]</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="n">results</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">list_stored_info_types</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">page_size</span><span class="o">=</span><span class="n">page_size</span><span class="p">,</span> |
| <span class="n">order_by</span><span class="o">=</span><span class="n">order_by</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.redact_image"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.redact_image">[docs]</a> <span class="k">def</span> <span class="nf">redact_image</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">image_redaction_configs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">include_findings</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">byte_item</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Redacts potentially sensitive info from an image. This method has limits on</span> |
| <span class="sd"> input size, processing time, and output size.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param inspect_config: (Optional) Configuration for the inspector. Items specified</span> |
| <span class="sd"> here will override the template referenced by the inspect_template_name argument.</span> |
| <span class="sd"> :type inspect_config: dict or google.cloud.dlp_v2.types.InspectConfig</span> |
| <span class="sd"> :param image_redaction_configs: (Optional) The configuration for specifying what</span> |
| <span class="sd"> content to redact from images.</span> |
| <span class="sd"> :type image_redaction_configs: list[dict] or list[google.cloud.dlp_v2.types.ImageRedactionConfig]</span> |
| <span class="sd"> :param include_findings: (Optional) Whether the response should include findings</span> |
| <span class="sd"> along with the redacted image.</span> |
| <span class="sd"> :type include_findings: bool</span> |
| <span class="sd"> :param byte_item: (Optional) The content must be PNG, JPEG, SVG or BMP.</span> |
| <span class="sd"> :type byte_item: dict or google.cloud.dlp_v2.types.ByteContentItem</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.RedactImageResponse</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">redact_image</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="n">inspect_config</span><span class="p">,</span> |
| <span class="n">image_redaction_configs</span><span class="o">=</span><span class="n">image_redaction_configs</span><span class="p">,</span> |
| <span class="n">include_findings</span><span class="o">=</span><span class="n">include_findings</span><span class="p">,</span> |
| <span class="n">byte_item</span><span class="o">=</span><span class="n">byte_item</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.reidentify_content"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.reidentify_content">[docs]</a> <span class="k">def</span> <span class="nf">reidentify_content</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">reidentify_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">item</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_template_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">reidentify_template_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Re-identifies content that has been de-identified.</span> |
| |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param reidentify_config: (Optional) Configuration for the re-identification of</span> |
| <span class="sd"> the content item.</span> |
| <span class="sd"> :type reidentify_config: dict or google.cloud.dlp_v2.types.DeidentifyConfig</span> |
| <span class="sd"> :param inspect_config: (Optional) Configuration for the inspector.</span> |
| <span class="sd"> :type inspect_config: dict or google.cloud.dlp_v2.types.InspectConfig</span> |
| <span class="sd"> :param item: (Optional) The item to re-identify. Will be treated as text.</span> |
| <span class="sd"> :type item: dict or google.cloud.dlp_v2.types.ContentItem</span> |
| <span class="sd"> :param inspect_template_name: (Optional) Optional template to use. Any configuration</span> |
| <span class="sd"> directly specified in inspect_config will override those set in the template.</span> |
| <span class="sd"> :type inspect_template_name: str</span> |
| <span class="sd"> :param reidentify_template_name: (Optional) Optional template to use. References an</span> |
| <span class="sd"> instance of deidentify template. Any configuration directly specified in</span> |
| <span class="sd"> reidentify_config or inspect_config will override those set in the template.</span> |
| <span class="sd"> :type reidentify_template_name: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.ReidentifyContentResponse</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">reidentify_content</span><span class="p">(</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">reidentify_config</span><span class="o">=</span><span class="n">reidentify_config</span><span class="p">,</span> |
| <span class="n">inspect_config</span><span class="o">=</span><span class="n">inspect_config</span><span class="p">,</span> |
| <span class="n">item</span><span class="o">=</span><span class="n">item</span><span class="p">,</span> |
| <span class="n">inspect_template_name</span><span class="o">=</span><span class="n">inspect_template_name</span><span class="p">,</span> |
| <span class="n">reidentify_template_name</span><span class="o">=</span><span class="n">reidentify_template_name</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.update_deidentify_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_deidentify_template">[docs]</a> <span class="k">def</span> <span class="nf">update_deidentify_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">deidentify_template</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates the deidentify template.</span> |
| |
| <span class="sd"> :param template_id: The ID of deidentify template to be updated.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param deidentify_template: New deidentify template value.</span> |
| <span class="sd"> :type deidentify_template: dict or google.cloud.dlp_v2.types.DeidentifyTemplate</span> |
| <span class="sd"> :param update_mask: Mask to control which fields get updated.</span> |
| <span class="sd"> :type update_mask: dict or google.cloud.dlp_v2.types.FieldMask</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.DeidentifyTemplate</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">template_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of deidentify template to be updated."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_deidentify_template_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_deidentify_template_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">update_deidentify_template</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">deidentify_template</span><span class="o">=</span><span class="n">deidentify_template</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="n">update_mask</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.update_inspect_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_inspect_template">[docs]</a> <span class="k">def</span> <span class="nf">update_inspect_template</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">template_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">inspect_template</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates the inspect template.</span> |
| |
| <span class="sd"> :param template_id: The ID of the inspect template to be updated.</span> |
| <span class="sd"> :type template_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param inspect_template: New inspect template value.</span> |
| <span class="sd"> :type inspect_template: dict or google.cloud.dlp_v2.types.InspectTemplate</span> |
| <span class="sd"> :param update_mask: Mask to control which fields get updated.</span> |
| <span class="sd"> :type update_mask: dict or google.cloud.dlp_v2.types.FieldMask</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.InspectTemplate</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">template_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the inspect template to be updated."</span> |
| <span class="p">)</span> |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_inspect_template_path</span><span class="p">(</span><span class="n">organization_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_inspect_template_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">template_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">update_inspect_template</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">inspect_template</span><span class="o">=</span><span class="n">inspect_template</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="n">update_mask</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudDLPHook.update_job_trigger"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_job_trigger">[docs]</a> <span class="k">def</span> <span class="nf">update_job_trigger</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">job_trigger_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">job_trigger</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates a job trigger.</span> |
| |
| <span class="sd"> :param job_trigger_id: The ID of the DLP job trigger to be updated.</span> |
| <span class="sd"> :type job_trigger_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. If set to None or missing, the default</span> |
| <span class="sd"> project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param job_trigger: New job trigger value.</span> |
| <span class="sd"> :type job_trigger: dict or google.cloud.dlp_v2.types.JobTrigger</span> |
| <span class="sd"> :param update_mask: Mask to control which fields get updated.</span> |
| <span class="sd"> :type update_mask: dict or google.cloud.dlp_v2.types.FieldMask</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.JobTrigger</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">job_trigger_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the DLP job trigger to be updated."</span> |
| <span class="p">)</span> |
| |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_job_trigger_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">job_trigger_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">update_job_trigger</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">job_trigger</span><span class="o">=</span><span class="n">job_trigger</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="n">update_mask</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudDLPHook.update_stored_info_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_dlp_hook/index.html#airflow.contrib.hooks.gcp_dlp_hook.CloudDLPHook.update_stored_info_type">[docs]</a> <span class="k">def</span> <span class="nf">update_stored_info_type</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span><span class="p">,</span> |
| <span class="n">organization_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates the stored info type by creating a new version.</span> |
| |
| <span class="sd"> :param stored_info_type_id: The ID of the stored info type to be updated.</span> |
| <span class="sd"> :type stored_info_type_id: str</span> |
| <span class="sd"> :param organization_id: (Optional) The organization ID. Required to set this</span> |
| <span class="sd"> field if parent resource is an organzation.</span> |
| <span class="sd"> :type organization_id: str</span> |
| <span class="sd"> :param project_id: (Optional) Google Cloud Platform project ID where the</span> |
| <span class="sd"> DLP Instance exists. Only set this field if the parent resource is</span> |
| <span class="sd"> a project instead of an organzation.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param config: Updated configuration for the stored info type. If not provided, a new</span> |
| <span class="sd"> version of the stored info type will be created with the existing configuration.</span> |
| <span class="sd"> :type config: dict or google.cloud.dlp_v2.types.StoredInfoTypeConfig</span> |
| <span class="sd"> :param update_mask: Mask to control which fields get updated.</span> |
| <span class="sd"> :type update_mask: dict or google.cloud.dlp_v2.types.FieldMask</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request</span> |
| <span class="sd"> to complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]]</span> |
| <span class="sd"> :rtype: google.cloud.dlp_v2.types.StoredInfoType</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">stored_info_type_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide the ID of the stored info type to be updated."</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Handle project_id from connection configuration</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="n">organization_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">organization_stored_info_type_path</span><span class="p">(</span> |
| <span class="n">organization_id</span><span class="p">,</span> <span class="n">stored_info_type_id</span> |
| <span class="p">)</span> |
| <span class="k">elif</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">DlpServiceClient</span><span class="o">.</span><span class="n">project_stored_info_type_path</span><span class="p">(</span> |
| <span class="n">project_id</span><span class="p">,</span> |
| <span class="n">stored_info_type_id</span> |
| <span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Please provide either organization_id or project_id."</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">update_stored_info_type</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="n">update_mask</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| |
| <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> |
