| |
| |
| |
| |
| |
| <!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_vision_hook — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.5 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><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> |
| |
| |
| |
| </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_vision_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_vision_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="kn">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</span> |
| |
| <span class="kn">from</span> <span class="nn">cached_property</span> <span class="k">import</span> <span class="n">cached_property</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.vision_v1</span> <span class="k">import</span> <span class="n">ProductSearchClient</span><span class="p">,</span> <span class="n">ImageAnnotatorClient</span> |
| <span class="kn">from</span> <span class="nn">google.protobuf.json_format</span> <span class="k">import</span> <span class="n">MessageToDict</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="NameDeterminer"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.NameDeterminer">[docs]</a><span class="k">class</span> <span class="nc">NameDeterminer</span><span class="p">:</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Class used for checking if the entity has the 'name' attribute set.</span> |
| |
| <span class="sd"> * If so, no action is taken.</span> |
| |
| <span class="sd"> * If not, and the name can be constructed from other parameters provided, it is created and filled in</span> |
| <span class="sd"> the entity.</span> |
| |
| <span class="sd"> * If both the entity's 'name' attribute is set and the name can be constructed from other parameters</span> |
| <span class="sd"> provided:</span> |
| |
| <span class="sd"> * If they are the same - no action is taken</span> |
| |
| <span class="sd"> * if they are different - an exception is thrown.</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">label</span><span class="p">,</span> <span class="n">id_label</span><span class="p">,</span> <span class="n">get_path</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">label</span> <span class="o">=</span> <span class="n">label</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">id_label</span> <span class="o">=</span> <span class="n">id_label</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">get_path</span> <span class="o">=</span> <span class="n">get_path</span> |
| |
| <div class="viewcode-block" id="NameDeterminer.get_entity_with_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.NameDeterminer.get_entity_with_name">[docs]</a> <span class="k">def</span> <span class="nf">get_entity_with_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entity</span><span class="p">,</span> <span class="n">entity_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</span> |
| <span class="n">entity</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span> |
| <span class="n">explicit_name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">entity</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">location</span> <span class="ow">and</span> <span class="n">entity_id</span><span class="p">:</span> |
| <span class="c1"># Necessary parameters to construct the name are present. Checking for conflict with explicit name</span> |
| <span class="n">constructed_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">entity_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">explicit_name</span><span class="p">:</span> |
| <span class="n">entity</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">constructed_name</span> |
| <span class="k">return</span> <span class="n">entity</span> |
| <span class="k">elif</span> <span class="n">explicit_name</span> <span class="o">!=</span> <span class="n">constructed_name</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_raise_ex_different_names</span><span class="p">(</span><span class="n">constructed_name</span><span class="p">,</span> <span class="n">explicit_name</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># Not enough parameters to construct the name. Trying to use the name from Product / ProductSet.</span> |
| <span class="k">if</span> <span class="n">explicit_name</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">entity</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_raise_ex_unable_to_determine_name</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="NameDeterminer._raise_ex_unable_to_determine_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.NameDeterminer._raise_ex_unable_to_determine_name">[docs]</a> <span class="k">def</span> <span class="nf">_raise_ex_unable_to_determine_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Unable to determine the </span><span class="si">{label}</span><span class="s2"> name. Please either set the name directly in the </span><span class="si">{label}</span><span class="s2"> "</span> |
| <span class="s2">"object or provide the `location` and `</span><span class="si">{id_label}</span><span class="s2">` parameters."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">label</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">label</span><span class="p">,</span> <span class="n">id_label</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id_label</span></div> |
| <span class="p">)</span> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="NameDeterminer._raise_ex_different_names"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.NameDeterminer._raise_ex_different_names">[docs]</a> <span class="k">def</span> <span class="nf">_raise_ex_different_names</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">constructed_name</span><span class="p">,</span> <span class="n">explicit_name</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"The </span><span class="si">{label}</span><span class="s2"> name provided in the object (</span><span class="si">{explicit_name}</span><span class="s2">) is different than the name created "</span> |
| <span class="s2">"from the input parameters (</span><span class="si">{constructed_name}</span><span class="s2">). Please either: 1) Remove the </span><span class="si">{label}</span><span class="s2"> name, 2) "</span> |
| <span class="s2">"Remove the location and </span><span class="si">{id_label}</span><span class="s2"> parameters, 3) Unify the </span><span class="si">{label}</span><span class="s2"> name and input "</span> |
| <span class="s2">"parameters."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">label</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">label</span><span class="p">,</span> |
| <span class="n">explicit_name</span><span class="o">=</span><span class="n">explicit_name</span><span class="p">,</span> |
| <span class="n">constructed_name</span><span class="o">=</span><span class="n">constructed_name</span><span class="p">,</span> |
| <span class="n">id_label</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id_label</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionHook</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 Vision APIs.</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="CloudVisionHook._client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook._client">[docs]</a> <span class="n">_client</span> <span class="o">=</span> <span class="kc">None</span></div> |
| <div class="viewcode-block" id="CloudVisionHook.product_name_determiner"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.product_name_determiner">[docs]</a> <span class="n">product_name_determiner</span> <span class="o">=</span> <span class="n">NameDeterminer</span><span class="p">(</span><span class="s1">'Product'</span><span class="p">,</span> <span class="s1">'product_id'</span><span class="p">,</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_path</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="CloudVisionHook.product_set_name_determiner"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.product_set_name_determiner">[docs]</a> <span class="n">product_set_name_determiner</span> <span class="o">=</span> <span class="n">NameDeterminer</span><span class="p">(</span> |
| <span class="s1">'ProductSet'</span><span class="p">,</span> <span class="s1">'productset_id'</span><span class="p">,</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_set_path</span></div> |
| <span class="p">)</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="s1">'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">CloudVisionHook</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> |
| |
| <div class="viewcode-block" id="CloudVisionHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.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"> Retrieves connection to Cloud Vision.</span> |
| |
| <span class="sd"> :return: Google Cloud Vision client object.</span> |
| <span class="sd"> :rtype: google.cloud.vision_v1.ProductSearchClient</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">ProductSearchClient</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">@cached_property</span> |
| <div class="viewcode-block" id="CloudVisionHook.annotator_client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.annotator_client">[docs]</a> <span class="k">def</span> <span class="nf">annotator_client</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">ImageAnnotatorClient</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></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudVisionHook._check_for_error"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook._check_for_error">[docs]</a> <span class="k">def</span> <span class="nf">_check_for_error</span><span class="p">(</span><span class="n">response</span><span class="p">):</span> |
| <span class="k">if</span> <span class="s2">"error"</span> <span class="ow">in</span> <span class="n">response</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.create_product_set"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.create_product_set">[docs]</a> <span class="k">def</span> <span class="nf">create_product_set</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">location</span><span class="p">,</span> |
| <span class="n">product_set</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">product_set_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"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetCreateOperator`</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">ProductSearchClient</span><span class="o">.</span><span class="n">location_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</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">'Creating a new ProductSet under the parent: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_product_set</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">product_set</span><span class="o">=</span><span class="n">product_set</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="n">product_set_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="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">'ProductSet created: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">name</span> <span class="k">if</span> <span class="n">response</span> <span class="k">else</span> <span class="s1">''</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">debug</span><span class="p">(</span><span class="s1">'ProductSet created:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">product_set_id</span><span class="p">:</span> |
| <span class="c1"># Product set id was generated by the API</span> |
| <span class="n">product_set_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_autogenerated_id</span><span class="p">(</span><span class="n">response</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">'Extracted autogenerated ProductSet ID from the response: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">product_set_id</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">product_set_id</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="CloudVisionHook.get_product_set"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.get_product_set">[docs]</a> <span class="k">def</span> <span class="nf">get_product_set</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_set_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"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetGetOperator`</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">name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_set_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_set_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">'Retrieving ProductSet: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_product_set</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><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">'ProductSet retrieved.'</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">debug</span><span class="p">(</span><span class="s1">'ProductSet retrieved:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.update_product_set"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.update_product_set">[docs]</a> <span class="k">def</span> <span class="nf">update_product_set</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">product_set</span><span class="p">,</span> |
| <span class="n">location</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">product_set_id</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">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="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetUpdateOperator`</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">product_set</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_set_name_determiner</span><span class="o">.</span><span class="n">get_entity_with_name</span><span class="p">(</span> |
| <span class="n">product_set</span><span class="p">,</span> <span class="n">product_set_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</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">'Updating ProductSet: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">product_set</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">update_product_set</span><span class="p">(</span> |
| <span class="n">product_set</span><span class="o">=</span><span class="n">product_set</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> |
| <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">'ProductSet updated: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">name</span> <span class="k">if</span> <span class="n">response</span> <span class="k">else</span> <span class="s1">''</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">debug</span><span class="p">(</span><span class="s1">'ProductSet updated:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.delete_product_set"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.delete_product_set">[docs]</a> <span class="k">def</span> <span class="nf">delete_product_set</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_set_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"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetDeleteOperator`</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">name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_set_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_set_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">'Deleting ProductSet: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_product_set</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><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">'ProductSet with the name [</span><span class="si">%s</span><span class="s1">] deleted.'</span><span class="p">,</span> <span class="n">name</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="CloudVisionHook.create_product"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.create_product">[docs]</a> <span class="k">def</span> <span class="nf">create_product</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product</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">product_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"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductCreateOperator`</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">ProductSearchClient</span><span class="o">.</span><span class="n">location_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</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">'Creating a new Product under the parent: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_product</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">product</span><span class="o">=</span><span class="n">product</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="n">product_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="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">'Product created: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">name</span> <span class="k">if</span> <span class="n">response</span> <span class="k">else</span> <span class="s1">''</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">debug</span><span class="p">(</span><span class="s1">'Product created:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">product_id</span><span class="p">:</span> |
| <span class="c1"># Product id was generated by the API</span> |
| <span class="n">product_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_autogenerated_id</span><span class="p">(</span><span class="n">response</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">'Extracted autogenerated Product ID from the response: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">product_id</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">product_id</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="CloudVisionHook.get_product"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.get_product">[docs]</a> <span class="k">def</span> <span class="nf">get_product</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_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"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductGetOperator`</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">name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_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">'Retrieving Product: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_product</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><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">'Product retrieved.'</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">debug</span><span class="p">(</span><span class="s1">'Product retrieved:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.update_product"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.update_product">[docs]</a> <span class="k">def</span> <span class="nf">update_product</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">product</span><span class="p">,</span> |
| <span class="n">location</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">product_id</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">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="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductUpdateOperator`</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">product</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_name_determiner</span><span class="o">.</span><span class="n">get_entity_with_name</span><span class="p">(</span><span class="n">product</span><span class="p">,</span> <span class="n">product_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</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">'Updating ProductSet: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">product</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">update_product</span><span class="p">(</span> |
| <span class="n">product</span><span class="o">=</span><span class="n">product</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> |
| <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">'Product updated: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">name</span> <span class="k">if</span> <span class="n">response</span> <span class="k">else</span> <span class="s1">''</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">debug</span><span class="p">(</span><span class="s1">'Product updated:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.delete_product"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.delete_product">[docs]</a> <span class="k">def</span> <span class="nf">delete_product</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_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"> For the documentation see:</span> |
| <span class="sd"> :class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionProductDeleteOperator`</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">name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_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">'Deleting ProductSet: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="n">client</span><span class="o">.</span><span class="n">delete_product</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><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">'Product with the name [</span><span class="si">%s</span><span class="s1">] deleted:'</span><span class="p">,</span> <span class="n">name</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="CloudVisionHook.create_reference_image"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.create_reference_image">[docs]</a> <span class="k">def</span> <span class="nf">create_reference_image</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">location</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="p">,</span> |
| <span class="n">reference_image</span><span class="p">,</span> |
| <span class="n">reference_image_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="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator`</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="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">'Creating ReferenceImage'</span><span class="p">)</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_path</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="n">product_id</span><span class="p">)</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_reference_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">reference_image</span><span class="o">=</span><span class="n">reference_image</span><span class="p">,</span> |
| <span class="n">reference_image_id</span><span class="o">=</span><span class="n">reference_image_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="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">'ReferenceImage created: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">name</span> <span class="k">if</span> <span class="n">response</span> <span class="k">else</span> <span class="s1">''</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">debug</span><span class="p">(</span><span class="s1">'ReferenceImage created:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">reference_image_id</span><span class="p">:</span> |
| <span class="c1"># Reference image id was generated by the API</span> |
| <span class="n">reference_image_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_autogenerated_id</span><span class="p">(</span><span class="n">response</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">'Extracted autogenerated ReferenceImage ID from the response: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">reference_image_id</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">reference_image_id</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="CloudVisionHook.delete_reference_image"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.delete_reference_image">[docs]</a> <span class="k">def</span> <span class="nf">delete_reference_image</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">location</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="p">,</span> |
| <span class="n">reference_image_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="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator`</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="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">'Deleting ReferenceImage'</span><span class="p">)</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">reference_image_path</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="n">product_id</span><span class="p">,</span> <span class="n">reference_image</span><span class="o">=</span><span class="n">reference_image_id</span> |
| <span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">delete_reference_image</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><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">'ReferenceImage with the name [</span><span class="si">%s</span><span class="s1">] deleted.'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.add_product_to_product_set"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.add_product_to_product_set">[docs]</a> <span class="k">def</span> <span class="nf">add_product_to_product_set</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="p">,</span> |
| <span class="n">location</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="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionAddProductToProductSetOperator`</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">product_name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_id</span><span class="p">)</span> |
| <span class="n">product_set_name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_set_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_set_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">'Add Product[name=</span><span class="si">%s</span><span class="s1">] to Product Set[name=</span><span class="si">%s</span><span class="s1">]'</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">product_set_name</span><span class="p">)</span> |
| |
| <span class="n">client</span><span class="o">.</span><span class="n">add_product_to_product_set</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">product_set_name</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="n">product_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> |
| |
| <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">'Product added to Product Set'</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="CloudVisionHook.remove_product_from_product_set"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.remove_product_from_product_set">[docs]</a> <span class="k">def</span> <span class="nf">remove_product_from_product_set</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="p">,</span> |
| <span class="n">location</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="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionRemoveProductFromProductSetOperator`</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">product_name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_id</span><span class="p">)</span> |
| <span class="n">product_set_name</span> <span class="o">=</span> <span class="n">ProductSearchClient</span><span class="o">.</span><span class="n">product_set_path</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">product_set_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">'Remove Product[name=</span><span class="si">%s</span><span class="s1">] from Product Set[name=</span><span class="si">%s</span><span class="s1">]'</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">product_set_name</span><span class="p">)</span> |
| |
| <span class="n">client</span><span class="o">.</span><span class="n">remove_product_from_product_set</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">product_set_name</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="n">product_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> |
| |
| <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">'Product removed from Product Set'</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="CloudVisionHook.annotate_image"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.annotate_image">[docs]</a> <span class="k">def</span> <span class="nf">annotate_image</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</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="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_image_annotator_operator.CloudVisionAnnotateImage`</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">annotator_client</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">'Annotating image'</span><span class="p">)</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">annotate_image</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</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="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">'Image annotated'</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.batch_annotate_images"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.batch_annotate_images">[docs]</a> <span class="k">def</span> <span class="nf">batch_annotate_images</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">requests</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="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_image_annotator_operator.CloudVisionAnnotateImage`</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">annotator_client</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">'Annotating images'</span><span class="p">)</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">batch_annotate_images</span><span class="p">(</span><span class="n">requests</span><span class="o">=</span><span class="n">requests</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="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">'Images annotated'</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</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="CloudVisionHook.text_detection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.text_detection">[docs]</a> <span class="k">def</span> <span class="nf">text_detection</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">max_results</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">additional_properties</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectTextOperator`</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">annotator_client</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="s2">"Detecting text"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">additional_properties</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">additional_properties</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">text_detection</span><span class="p">(</span> |
| <span class="n">image</span><span class="o">=</span><span class="n">image</span><span class="p">,</span> <span class="n">max_results</span><span class="o">=</span><span class="n">max_results</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="o">**</span><span class="n">additional_properties</span> |
| <span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_for_error</span><span class="p">(</span><span class="n">response</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="s2">"Text detection finished"</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">response</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudVisionHook.document_text_detection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.document_text_detection">[docs]</a> <span class="k">def</span> <span class="nf">document_text_detection</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">max_results</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">additional_properties</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectDocumentTextOperator`</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">annotator_client</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="s2">"Detecting document text"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">additional_properties</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">additional_properties</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">document_text_detection</span><span class="p">(</span> |
| <span class="n">image</span><span class="o">=</span><span class="n">image</span><span class="p">,</span> <span class="n">max_results</span><span class="o">=</span><span class="n">max_results</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="o">**</span><span class="n">additional_properties</span> |
| <span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_for_error</span><span class="p">(</span><span class="n">response</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="s2">"Document text detection finished"</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">response</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudVisionHook.label_detection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.label_detection">[docs]</a> <span class="k">def</span> <span class="nf">label_detection</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">max_results</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">additional_properties</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageLabelsOperator`</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">annotator_client</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="s2">"Detecting labels"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">additional_properties</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">additional_properties</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">label_detection</span><span class="p">(</span> |
| <span class="n">image</span><span class="o">=</span><span class="n">image</span><span class="p">,</span> <span class="n">max_results</span><span class="o">=</span><span class="n">max_results</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="o">**</span><span class="n">additional_properties</span> |
| <span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_for_error</span><span class="p">(</span><span class="n">response</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="s2">"Labels detection finished"</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">response</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span> |
| <div class="viewcode-block" id="CloudVisionHook.safe_search_detection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook.safe_search_detection">[docs]</a> <span class="k">def</span> <span class="nf">safe_search_detection</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">max_results</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">additional_properties</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> For the documentation see:</span> |
| <span class="sd"> :py:class:`~airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageSafeSearchOperator`</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">annotator_client</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="s2">"Detecting safe search"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">additional_properties</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">additional_properties</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">safe_search_detection</span><span class="p">(</span> |
| <span class="n">image</span><span class="o">=</span><span class="n">image</span><span class="p">,</span> <span class="n">max_results</span><span class="o">=</span><span class="n">max_results</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="o">**</span><span class="n">additional_properties</span> |
| <span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">MessageToDict</span><span class="p">(</span><span class="n">response</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_for_error</span><span class="p">(</span><span class="n">response</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="s2">"Safe search detection finished"</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">response</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudVisionHook._get_autogenerated_id"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_vision_hook/index.html#airflow.contrib.hooks.gcp_vision_hook.CloudVisionHook._get_autogenerated_id">[docs]</a> <span class="k">def</span> <span class="nf">_get_autogenerated_id</span><span class="p">(</span><span class="n">response</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">name</span> |
| <span class="k">except</span> <span class="ne">AttributeError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Unable to get name from response... [</span><span class="si">{}</span><span class="s1">]</span><span class="se">\n</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">response</span><span class="p">,</span> <span class="n">e</span><span class="p">))</span> |
| <span class="k">if</span> <span class="s1">'/'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Unable to get id from name... [</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">name</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">name</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span></div></div> |
| </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> |