pydoc/2.22.0/apache_beam.ml.gcp.cloud_dlp.html - beam-site - Git at Google



 <!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>apache_beam.ml.gcp.cloud_dlp module &mdash; Apache Beam  documentation</title>


   <script type="text/javascript" src="_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
         <script type="text/javascript" src="_static/jquery.js"></script>
         <script type="text/javascript" src="_static/underscore.js"></script>
         <script type="text/javascript" src="_static/doctools.js"></script>
         <script type="text/javascript" src="_static/language_data.js"></script>

     <script type="text/javascript" src="_static/js/theme.js"></script>


   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="apache_beam.ml.gcp.naturallanguageml module" href="apache_beam.ml.gcp.naturallanguageml.html" />
     <link rel="prev" title="apache_beam.ml.gcp package" href="apache_beam.ml.gcp.html" />
 </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"> Apache Beam


           </a>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.ml.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a><ul class="current">
 <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.ml.gcp.html#submodules">Submodules</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</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">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">

         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="index.html">Docs</a> &raquo;</li>

           <li><a href="apache_beam.ml.html">apache_beam.ml package</a> &raquo;</li>

           <li><a href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a> &raquo;</li>

       <li>apache_beam.ml.gcp.cloud_dlp module</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/apache_beam.ml.gcp.cloud_dlp.rst.txt" rel="nofollow"> View page source</a>


       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <div class="section" id="module-apache_beam.ml.gcp.cloud_dlp">
 <span id="apache-beam-ml-gcp-cloud-dlp-module"></span><h1>apache_beam.ml.gcp.cloud_dlp module<a class="headerlink" href="#module-apache_beam.ml.gcp.cloud_dlp" title="Permalink to this headline">¶</a></h1>
 <p><code class="docutils literal notranslate"><span class="pre">PTransforms</span></code> that implement Google Cloud Data Loss Prevention
 functionality.</p>
 <dl class="class">
 <dt id="apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails">
 <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.cloud_dlp.</code><code class="descname">MaskDetectedDetails</code><span class="sig-paren">(</span><em>project=None</em>, <em>deidentification_template_name=None</em>, <em>deidentification_config=None</em>, <em>inspection_template_name=None</em>, <em>inspection_config=None</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#MaskDetectedDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
 <p>Scrubs sensitive information detected in text.
 The <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> returns a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of <code class="docutils literal notranslate"><span class="pre">str</span></code>
 Example usage:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> <span class="o">|</span> <span class="n">MaskDetectedDetails</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">&#39;example-gcp-project&#39;</span><span class="p">,</span>
   <span class="n">deidentification_config</span><span class="o">=</span><span class="p">{</span>
       <span class="s1">&#39;info_type_transformations: {</span>
           <span class="s1">&#39;transformations&#39;</span><span class="p">:</span> <span class="p">[{</span>
               <span class="s1">&#39;primitive_transformation&#39;</span><span class="p">:</span> <span class="p">{</span>
                   <span class="s1">&#39;character_mask_config&#39;</span><span class="p">:</span> <span class="p">{</span>
                       <span class="s1">&#39;masking_character&#39;</span><span class="p">:</span> <span class="s1">&#39;#&#39;</span>
                   <span class="p">}</span>
               <span class="p">}</span>
           <span class="p">}]</span>
       <span class="p">}</span>
   <span class="p">},</span> <span class="n">inspection_config</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;info_types&#39;</span><span class="p">:</span> <span class="p">[{</span><span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;EMAIL_ADDRESS&#39;</span><span class="p">}]})</span>
 </pre></div>
 </div>
 <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails" title="apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaskDetectedDetails</span></code></a> transform.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>project</strong> – Optional. GCP project name in which inspection will be performed</li>
 <li><strong>deidentification_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – Either this or
 <cite>deidentification_config</cite> required. Name of
 deidentification template to be used on detected sensitive information
 instances in text.</li>
 <li><strong>deidentification_config</strong> – (<code class="docutils literal notranslate"><span class="pre">Union[dict,</span> <span class="pre">google.cloud.dlp_v2.types.DeidentifyConfig]</span></code>):
 Configuration for the de-identification of the content item.
 If both template name and config are supplied,
 config is more important.</li>
 <li><strong>inspection_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – This or <cite>inspection_config</cite> required.
 Name of inspection template to be used
 to detect sensitive data in text.</li>
 <li><strong>inspection_config</strong> – (<code class="docutils literal notranslate"><span class="pre">Union[dict,</span> <span class="pre">google.cloud.dlp_v2.types.InspectConfig]</span></code>):
 Configuration for the inspector used to detect sensitive data in text.
 If both template name and config are supplied,
 config takes precedence.</li>
 <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait for
 the request to complete.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails.expand">
 <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#MaskDetectedDetails.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails.expand" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.ml.gcp.cloud_dlp.InspectForDetails">
 <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.cloud_dlp.</code><code class="descname">InspectForDetails</code><span class="sig-paren">(</span><em>project=None</em>, <em>inspection_template_name=None</em>, <em>inspection_config=None</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#InspectForDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.InspectForDetails" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
 <p>Inspects input text for sensitive information.
 the <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> returns a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of
 <code class="docutils literal notranslate"><span class="pre">List[google.cloud.dlp_v2.proto.dlp_pb2.Finding]</span></code>
 Example usage:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> <span class="o">|</span> <span class="n">InspectForDetails</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">&#39;example-gcp-project&#39;</span><span class="p">,</span>
           <span class="n">inspection_config</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;info_types&#39;</span><span class="p">:</span> <span class="p">[{</span><span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;EMAIL_ADDRESS&#39;</span><span class="p">}]})</span>
 </pre></div>
 </div>
 <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.cloud_dlp.InspectForDetails" title="apache_beam.ml.gcp.cloud_dlp.InspectForDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">InspectForDetails</span></code></a> transform.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>project</strong> – Optional. GCP project name in which inspection will be performed</li>
 <li><strong>inspection_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – This or <cite>inspection_config</cite> required.
 Name of inspection template to be used
 to detect sensitive data in text.</li>
 <li><strong>inspection_config</strong> – (<code class="docutils literal notranslate"><span class="pre">Union[dict,</span> <span class="pre">google.cloud.dlp_v2.types.InspectConfig]</span></code>):
 Configuration for the inspector used to detect sensitive data in text.
 If both template name and config are supplied,
 config takes precedence.</li>
 <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait for
 the request to complete.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.ml.gcp.cloud_dlp.InspectForDetails.expand">
 <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#InspectForDetails.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.InspectForDetails.expand" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.ml.gcp.naturallanguageml.html" class="btn btn-neutral float-right" title="apache_beam.ml.gcp.naturallanguageml module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.ml.gcp.html" class="btn btn-neutral float-left" title="apache_beam.ml.gcp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>


	<!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>apache_beam.ml.gcp.cloud_dlp module — Apache Beam documentation</title>








	<script type="text/javascript" src="_static/js/modernizr.min.js"></script>


	<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
	<script type="text/javascript" src="_static/jquery.js"></script>
	<script type="text/javascript" src="_static/underscore.js"></script>
	<script type="text/javascript" src="_static/doctools.js"></script>
	<script type="text/javascript" src="_static/language_data.js"></script>

	<script type="text/javascript" src="_static/js/theme.js"></script>




	<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
	<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="apache_beam.ml.gcp.naturallanguageml module" href="apache_beam.ml.gcp.naturallanguageml.html" />
	<link rel="prev" title="apache_beam.ml.gcp package" href="apache_beam.ml.gcp.html" />
	</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"> Apache Beam



	</a>







	<div role="search">
	<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
	<input type="text" name="q" placeholder="Search docs" />
	<input type="hidden" name="check_keywords" value="yes" />
	<input type="hidden" name="area" value="default" />
	</form>
	</div>


	</div>

	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






	<ul class="current">
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
	<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a><ul class="current">
	<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.ml.html#subpackages">Subpackages</a><ul class="current">
	<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a><ul class="current">
	<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.ml.gcp.html#submodules">Submodules</a></li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
	</ul>
	<ul>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</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">Apache Beam</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="apache_beam.ml.html">apache_beam.ml package</a> »</li>

	<li><a href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a> »</li>

	<li>apache_beam.ml.gcp.cloud_dlp module</li>


	<li class="wy-breadcrumbs-aside">


	<a href="_sources/apache_beam.ml.gcp.cloud_dlp.rst.txt" rel="nofollow"> View page source</a>


	</li>

	</ul>


	<hr/>
	</div>
	<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
	<div itemprop="articleBody">

	<div class="section" id="module-apache_beam.ml.gcp.cloud_dlp">
	<span id="apache-beam-ml-gcp-cloud-dlp-module"></span><h1>apache_beam.ml.gcp.cloud_dlp module<a class="headerlink" href="#module-apache_beam.ml.gcp.cloud_dlp" title="Permalink to this headline">¶</a></h1>
	<p><code class="docutils literal notranslate"><span class="pre">PTransforms</span></code> that implement Google Cloud Data Loss Prevention
	functionality.</p>
	<dl class="class">
	<dt id="apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails">
	<em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.cloud_dlp.</code><code class="descname">MaskDetectedDetails</code><span class="sig-paren">(</span><em>project=None</em>, <em>deidentification_template_name=None</em>, <em>deidentification_config=None</em>, <em>inspection_template_name=None</em>, <em>inspection_config=None</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#MaskDetectedDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
	<p>Scrubs sensitive information detected in text.
	The <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> returns a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of <code class="docutils literal notranslate"><span class="pre">str</span></code>
	Example usage:</p>
	<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> <span class="o">\|</span> <span class="n">MaskDetectedDetails</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span>
	<span class="n">deidentification_config</span><span class="o">=</span><span class="p">{</span>
	<span class="s1">'info_type_transformations: {</span>
	<span class="s1">'transformations'</span><span class="p">:</span> <span class="p">[{</span>
	<span class="s1">'primitive_transformation'</span><span class="p">:</span> <span class="p">{</span>
	<span class="s1">'character_mask_config'</span><span class="p">:</span> <span class="p">{</span>
	<span class="s1">'masking_character'</span><span class="p">:</span> <span class="s1">'#'</span>
	<span class="p">}</span>
	<span class="p">}</span>
	<span class="p">}]</span>
	<span class="p">}</span>
	<span class="p">},</span> <span class="n">inspection_config</span><span class="o">=</span><span class="p">{</span><span class="s1">'info_types'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'EMAIL_ADDRESS'</span><span class="p">}]})</span>
	</pre></div>
	</div>
	<p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails" title="apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaskDetectedDetails</span></code></a> transform.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
	<li><strong>project</strong> – Optional. GCP project name in which inspection will be performed</li>
	<li><strong>deidentification_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – Either this or
	<cite>deidentification_config</cite> required. Name of
	deidentification template to be used on detected sensitive information
	instances in text.</li>
	<li><strong>deidentification_config</strong> – (<code class="docutils literal notranslate"><span class="pre">Union[dict,</span> <span class="pre">google.cloud.dlp_v2.types.DeidentifyConfig]</span></code>):
	Configuration for the de-identification of the content item.
	If both template name and config are supplied,
	config is more important.</li>
	<li><strong>inspection_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – This or <cite>inspection_config</cite> required.
	Name of inspection template to be used
	to detect sensitive data in text.</li>
	<li><strong>inspection_config</strong> – (<code class="docutils literal notranslate"><span class="pre">Union[dict,</span> <span class="pre">google.cloud.dlp_v2.types.InspectConfig]</span></code>):
	Configuration for the inspector used to detect sensitive data in text.
	If both template name and config are supplied,
	config takes precedence.</li>
	<li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait for
	the request to complete.</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails.expand">
	<code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#MaskDetectedDetails.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.MaskDetectedDetails.expand" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.ml.gcp.cloud_dlp.InspectForDetails">
	<em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.cloud_dlp.</code><code class="descname">InspectForDetails</code><span class="sig-paren">(</span><em>project=None</em>, <em>inspection_template_name=None</em>, <em>inspection_config=None</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#InspectForDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.InspectForDetails" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
	<p>Inspects input text for sensitive information.
	the <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> returns a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of
	<code class="docutils literal notranslate"><span class="pre">List[google.cloud.dlp_v2.proto.dlp_pb2.Finding]</span></code>
	Example usage:</p>
	<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> <span class="o">\|</span> <span class="n">InspectForDetails</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span>
	<span class="n">inspection_config</span><span class="o">=</span><span class="p">{</span><span class="s1">'info_types'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'EMAIL_ADDRESS'</span><span class="p">}]})</span>
	</pre></div>
	</div>
	<p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.cloud_dlp.InspectForDetails" title="apache_beam.ml.gcp.cloud_dlp.InspectForDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">InspectForDetails</span></code></a> transform.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
	<li><strong>project</strong> – Optional. GCP project name in which inspection will be performed</li>
	<li><strong>inspection_template_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – This or <cite>inspection_config</cite> required.
	Name of inspection template to be used
	to detect sensitive data in text.</li>
	<li><strong>inspection_config</strong> – (<code class="docutils literal notranslate"><span class="pre">Union[dict,</span> <span class="pre">google.cloud.dlp_v2.types.InspectConfig]</span></code>):
	Configuration for the inspector used to detect sensitive data in text.
	If both template name and config are supplied,
	config takes precedence.</li>
	<li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait for
	the request to complete.</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.ml.gcp.cloud_dlp.InspectForDetails.expand">
	<code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/cloud_dlp.html#InspectForDetails.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.cloud_dlp.InspectForDetails.expand" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	</div>


	</div>

	</div>
	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="apache_beam.ml.gcp.naturallanguageml.html" class="btn btn-neutral float-right" title="apache_beam.ml.gcp.naturallanguageml module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="apache_beam.ml.gcp.html" class="btn btn-neutral float-left" title="apache_beam.ml.gcp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

	</div>


	<hr/>

	<div role="contentinfo">
	<p>
	© Copyright

	</p>
	</div>
	Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

	</footer>

	</div>
	</div>

	</section>

	</div>



	<script type="text/javascript">
	jQuery(function () {
	SphinxRtdTheme.Navigation.enable(true);
	});
	</script>






	</body>
	</html>