| |
| |
| |
| |
| <!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.operators.gcp_vision_operator — 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> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.4 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">API Reference</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="../operators.html">airflow.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.gcp_vision_operator</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.operators.gcp_vision_operator</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">google.api_core.exceptions</span> <span class="k">import</span> <span class="n">AlreadyExists</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_vision_hook</span> <span class="k">import</span> <span class="n">CloudVisionHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductSetCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductSetCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a new ProductSet resource.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductSetCreateOperator`</span> |
| |
| <span class="sd"> :param product_set: (Required) The ProductSet to create. If a dict is provided, it must be of the same</span> |
| <span class="sd"> form as the protobuf message `ProductSet`.</span> |
| <span class="sd"> :type product_set: dict or google.cloud.vision_v1.types.ProductSet</span> |
| <span class="sd"> :param location: (Required) The region where the ProductSet should be created. Valid regions</span> |
| <span class="sd"> (as of 2019-02-05) are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the ProductSet should be created. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param product_set_id: (Optional) A user-supplied resource id for this ProductSet.</span> |
| <span class="sd"> If set, the server will attempt to use this value as the resource id. If it is</span> |
| <span class="sd"> already in use, an error is returned with code ALREADY_EXISTS. Must be at most</span> |
| <span class="sd"> 128 characters long. It cannot contain the character /.</span> |
| <span class="sd"> :type product_set_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_productset_create_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductSetCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetCreateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"location"</span><span class="p">,</span> <span class="s2">"project_id"</span><span class="p">,</span> <span class="s2">"product_set_id"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_productset_create_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">product_set</span><span class="p">,</span> |
| <span class="n">location</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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductSetCreateOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set</span> <span class="o">=</span> <span class="n">product_set</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span> <span class="o">=</span> <span class="n">product_set_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductSetCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetCreateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">create_product_set</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</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</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">except</span> <span class="n">AlreadyExists</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">"Product set with id </span><span class="si">%s</span><span class="s2"> already exists. Exiting from the create operation."</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductSetGetOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetGetOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductSetGetOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets information associated with a ProductSet.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductSetGetOperator`</span> |
| |
| <span class="sd"> :param location: (Required) The region where the ProductSet is located. Valid regions (as of 2019-02-05)</span> |
| <span class="sd"> are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product_set_id: (Required) The resource id of this ProductSet.</span> |
| <span class="sd"> :type product_set_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the ProductSet is located. If set</span> |
| <span class="sd"> to None or missing, the default `project_id` from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_productset_get_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductSetGetOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetGetOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_set_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_productset_get_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductSetGetOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span> <span class="o">=</span> <span class="n">product_set_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductSetGetOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetGetOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_product_set</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductSetUpdateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetUpdateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductSetUpdateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Makes changes to a `ProductSet` resource. Only display_name can be updated currently.</span> |
| |
| <span class="sd"> .. note:: To locate the `ProductSet` resource, its `name` in the form</span> |
| <span class="sd"> `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` is necessary.</span> |
| |
| <span class="sd"> You can provide the `name` directly as an attribute of the `product_set` object.</span> |
| <span class="sd"> However, you can leave it blank and provide `location` and `product_set_id` instead</span> |
| <span class="sd"> (and optionally `project_id` - if not present, the connection default will be used)</span> |
| <span class="sd"> and the `name` will be created by the operator itself.</span> |
| |
| <span class="sd"> This mechanism exists for your convenience, to allow leaving the `project_id` empty</span> |
| <span class="sd"> and having Airflow use the connection default `project_id`.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductSetUpdateOperator`</span> |
| |
| <span class="sd"> :param product_set: (Required) The ProductSet resource which replaces the one on the</span> |
| <span class="sd"> server. If a dict is provided, it must be of the same form as the protobuf</span> |
| <span class="sd"> message `ProductSet`.</span> |
| <span class="sd"> :type product_set: dict or google.cloud.vision_v1.types.ProductSet</span> |
| <span class="sd"> :param location: (Optional) The region where the ProductSet is located. Valid regions (as of 2019-02-05)</span> |
| <span class="sd"> are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product_set_id: (Optional) The resource id of this ProductSet.</span> |
| <span class="sd"> :type product_set_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the ProductSet should be created. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param update_mask: (Optional) The `FieldMask` that specifies which fields to update. If update_mask</span> |
| <span class="sd"> isn’t specified, all mutable fields are to be updated. Valid mask path is display_name. If a dict is</span> |
| <span class="sd"> provided, it must be of the same form as the protobuf message `FieldMask`.</span> |
| <span class="sd"> :type update_mask: dict or google.cloud.vision_v1.types.FieldMask</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_productset_update_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductSetUpdateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetUpdateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_set_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_productset_update_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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">project_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">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductSetUpdateOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set</span> <span class="o">=</span> <span class="n">product_set</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">update_mask</span> <span class="o">=</span> <span class="n">update_mask</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span> <span class="o">=</span> <span class="n">product_set_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductSetUpdateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetUpdateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">update_product_set</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</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</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductSetDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductSetDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Permanently deletes a `ProductSet`. `Products` and `ReferenceImages` in the</span> |
| <span class="sd"> `ProductSet` are not deleted. The actual image files are not deleted from Google</span> |
| <span class="sd"> Cloud Storage.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductSetDeleteOperator`</span> |
| |
| <span class="sd"> :param location: (Required) The region where the ProductSet is located. Valid regions (as of 2019-02-05)</span> |
| <span class="sd"> are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product_set_id: (Required) The resource id of this ProductSet.</span> |
| <span class="sd"> :type product_set_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the ProductSet should be created.</span> |
| <span class="sd"> If set to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_productset_delete_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductSetDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_set_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_productset_delete_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductSetDeleteOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span> <span class="o">=</span> <span class="n">product_set_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductSetDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetDeleteOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">delete_product_set</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates and returns a new product resource.</span> |
| |
| <span class="sd"> Possible errors regarding the `Product` object provided:</span> |
| |
| <span class="sd"> - Returns `INVALID_ARGUMENT` if `display_name` is missing or longer than 4096 characters.</span> |
| <span class="sd"> - Returns `INVALID_ARGUMENT` if `description` is longer than 4096 characters.</span> |
| <span class="sd"> - Returns `INVALID_ARGUMENT` if `product_category` is missing or invalid.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductCreateOperator`</span> |
| |
| <span class="sd"> :param location: (Required) The region where the Product should be created. Valid regions</span> |
| <span class="sd"> (as of 2019-02-05) are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product: (Required) The product to create. If a dict is provided, it must be of the same form as</span> |
| <span class="sd"> the protobuf message `Product`.</span> |
| <span class="sd"> :type product: dict or google.cloud.vision_v1.types.Product</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product should be created. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param product_id: (Optional) A user-supplied resource id for this Product.</span> |
| <span class="sd"> If set, the server will attempt to use this value as the resource id. If it is</span> |
| <span class="sd"> already in use, an error is returned with code ALREADY_EXISTS. Must be at most</span> |
| <span class="sd"> 128 characters long. It cannot contain the character /.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_product_create_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductCreateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_product_create_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductCreateOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product</span> <span class="o">=</span> <span class="n">product</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductCreateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">create_product</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</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="bp">self</span><span class="o">.</span><span class="n">product</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">except</span> <span class="n">AlreadyExists</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 id </span><span class="si">%s</span><span class="s1"> already exists. Exiting from the create operation.'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductGetOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductGetOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductGetOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets information associated with a `Product`.</span> |
| |
| <span class="sd"> Possible errors:</span> |
| |
| <span class="sd"> - Returns `NOT_FOUND` if the `Product` does not exist.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductGetOperator`</span> |
| |
| <span class="sd"> :param location: (Required) The region where the Product is located. Valid regions (as of 2019-02-05) are:</span> |
| <span class="sd"> us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product_id: (Required) The resource id of this Product.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product is located. If set to</span> |
| <span class="sd"> None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_product_get_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductGetOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductGetOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_product_get_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductGetOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductGetOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductGetOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_product</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductUpdateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductUpdateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductUpdateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Makes changes to a Product resource. Only the display_name, description, and labels fields can be</span> |
| <span class="sd"> updated right now.</span> |
| |
| <span class="sd"> If labels are updated, the change will not be reflected in queries until the next index time.</span> |
| |
| <span class="sd"> .. note:: To locate the `Product` resource, its `name` in the form</span> |
| <span class="sd"> `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` is necessary.</span> |
| |
| <span class="sd"> You can provide the `name` directly as an attribute of the `product` object. However, you can leave it</span> |
| <span class="sd"> blank and provide `location` and `product_id` instead (and optionally `project_id` - if not present,</span> |
| <span class="sd"> the connection default will be used) and the `name` will be created by the operator itself.</span> |
| |
| <span class="sd"> This mechanism exists for your convenience, to allow leaving the `project_id` empty and having Airflow</span> |
| <span class="sd"> use the connection default `project_id`.</span> |
| |
| <span class="sd"> Possible errors related to the provided `Product`:</span> |
| |
| <span class="sd"> - Returns `NOT_FOUND` if the Product does not exist.</span> |
| <span class="sd"> - Returns `INVALID_ARGUMENT` if `display_name` is present in update_mask but is missing from the request</span> |
| <span class="sd"> or longer than 4096 characters.</span> |
| <span class="sd"> - Returns `INVALID_ARGUMENT` if `description` is present in update_mask but is longer than 4096</span> |
| <span class="sd"> characters.</span> |
| <span class="sd"> - Returns `INVALID_ARGUMENT` if `product_category` is present in update_mask.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductUpdateOperator`</span> |
| |
| <span class="sd"> :param product: (Required) The Product resource which replaces the one on the server. product.name is</span> |
| <span class="sd"> immutable. If a dict is provided, it must be of the same form as the protobuf message `Product`.</span> |
| <span class="sd"> :type product: dict or google.cloud.vision_v1.types.ProductSet</span> |
| <span class="sd"> :param location: (Optional) The region where the Product is located. Valid regions (as of 2019-02-05) are:</span> |
| <span class="sd"> us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product_id: (Optional) The resource id of this Product.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product is located. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param update_mask: (Optional) The `FieldMask` that specifies which fields to update. If update_mask</span> |
| <span class="sd"> isn’t specified, all mutable fields are to be updated. Valid mask paths include product_labels,</span> |
| <span class="sd"> display_name, and description. If a dict is provided, it must be of the same form as the protobuf</span> |
| <span class="sd"> message `FieldMask`.</span> |
| <span class="sd"> :type update_mask: dict or google.cloud.vision_v1.types.FieldMask</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_product_update_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductUpdateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductUpdateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_product_update_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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">project_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">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductUpdateOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product</span> <span class="o">=</span> <span class="n">product</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">update_mask</span> <span class="o">=</span> <span class="n">update_mask</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductUpdateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductUpdateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</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="bp">self</span><span class="o">.</span><span class="n">product</span><span class="p">,</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">update_mask</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionProductDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionProductDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Permanently deletes a product and its reference images.</span> |
| |
| <span class="sd"> Metadata of the product and all its images will be deleted right away, but search queries against</span> |
| <span class="sd"> ProductSets containing the product may still work until all related caches are refreshed.</span> |
| |
| <span class="sd"> Possible errors:</span> |
| |
| <span class="sd"> - Returns `NOT_FOUND` if the product does not exist.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionProductDeleteOperator`</span> |
| |
| <span class="sd"> :param location: (Required) The region where the Product is located. Valid regions (as of 2019-02-05) are:</span> |
| <span class="sd"> us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param product_id: (Required) The resource id of this Product.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product is located. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_product_delete_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionProductDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'location'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'product_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_product_delete_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionProductDeleteOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionProductDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductDeleteOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">delete_product</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionAnnotateImageOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAnnotateImageOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionAnnotateImageOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Run image detection and annotation for an image or a batch of images.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionAnnotateImageOperator`</span> |
| |
| <span class="sd"> :param request: (Required) Annotation request for image or a batch.</span> |
| <span class="sd"> If a dict is provided, it must be of the same form as the protobuf</span> |
| <span class="sd"> message class:`google.cloud.vision_v1.types.AnnotateImageRequest`</span> |
| <span class="sd"> :type request: list[dict or google.cloud.vision_v1.types.AnnotateImageRequest] for batch or</span> |
| <span class="sd"> dict or google.cloud.vision_v1.types.AnnotateImageRequest for single image.</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_annotate_image_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionAnnotateImageOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAnnotateImageOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'request'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_annotate_image_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionAnnotateImageOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">request</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| |
| <div class="viewcode-block" id="CloudVisionAnnotateImageOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAnnotateImageOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">hook</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">hook</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">timeout</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">response</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CloudVisionReferenceImageCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionReferenceImageCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates and returns a new ReferenceImage ID resource.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionReferenceImageCreateOperator`</span> |
| |
| <span class="sd"> :param location: (Required) The region where the Product is located. Valid regions (as of 2019-02-05) are:</span> |
| <span class="sd"> us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param reference_image: (Required) The reference image to create. If an image ID is specified, it is</span> |
| <span class="sd"> ignored.</span> |
| <span class="sd"> If a dict is provided, it must be of the same form as the protobuf message</span> |
| <span class="sd"> :class:`google.cloud.vision_v1.types.ReferenceImage`</span> |
| <span class="sd"> :type reference_image: dict or google.cloud.vision_v1.types.ReferenceImage</span> |
| <span class="sd"> :param reference_image_id: (Optional) A user-supplied resource id for the ReferenceImage to be added.</span> |
| <span class="sd"> If set, the server will attempt to use this value as the resource id. If it is already in use, an</span> |
| <span class="sd"> error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain</span> |
| <span class="sd"> the character `/`.</span> |
| <span class="sd"> :type reference_image_id: str</span> |
| <span class="sd"> :param product_id: (Optional) The resource id of this Product.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product is located. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_reference_image_create_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionReferenceImageCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="s2">"location"</span><span class="p">,</span> |
| <span class="s2">"reference_image"</span><span class="p">,</span> |
| <span class="s2">"product_id"</span><span class="p">,</span> |
| <span class="s2">"reference_image_id"</span><span class="p">,</span> |
| <span class="s2">"project_id"</span><span class="p">,</span> |
| <span class="s2">"gcp_conn_id"</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| <span class="c1"># [END vision_reference_image_create_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">location</span><span class="p">,</span> |
| <span class="n">reference_image</span><span class="p">,</span> |
| <span class="n">product_id</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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionReferenceImageCreateOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reference_image</span> <span class="o">=</span> <span class="n">reference_image</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reference_image_id</span> <span class="o">=</span> <span class="n">reference_image_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| |
| <div class="viewcode-block" id="CloudVisionReferenceImageCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_reference_image</span><span class="p">(</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">reference_image_id</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">except</span> <span class="n">AlreadyExists</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">"ReferenceImage with id </span><span class="si">%s</span><span class="s2"> already exists. Exiting from the create operation."</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">reference_image_id</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CloudVisionAddProductToProductSetOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAddProductToProductSetOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionAddProductToProductSetOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Adds a Product to the specified ProductSet. If the Product is already present, no change is made.</span> |
| |
| <span class="sd"> One Product can be added to at most 100 ProductSets.</span> |
| |
| <span class="sd"> Possible errors:</span> |
| |
| <span class="sd"> - Returns `NOT_FOUND` if the Product or the ProductSet doesn’t exist.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionAddProductToProductSetOperator`</span> |
| |
| <span class="sd"> :param product_set_id: (Required) The resource id for the ProductSet to modify.</span> |
| <span class="sd"> :type product_set_id: str</span> |
| <span class="sd"> :param product_id: (Required) The resource id of this Product.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param location: (Required) The region where the ProductSet is located. Valid regions (as of 2019-02-05)</span> |
| <span class="sd"> are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product is located. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_add_product_to_product_set_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionAddProductToProductSetOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAddProductToProductSetOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"location"</span><span class="p">,</span> <span class="s2">"product_set_id"</span><span class="p">,</span> <span class="s2">"product_id"</span><span class="p">,</span> <span class="s2">"project_id"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_add_product_to_product_set_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionAddProductToProductSetOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span> <span class="o">=</span> <span class="n">product_set_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| |
| <div class="viewcode-block" id="CloudVisionAddProductToProductSetOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAddProductToProductSetOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">add_product_to_product_set</span><span class="p">(</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_id</span><span class="p">,</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionRemoveProductFromProductSetOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionRemoveProductFromProductSetOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionRemoveProductFromProductSetOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Removes a Product from the specified ProductSet.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionRemoveProductFromProductSetOperator`</span> |
| |
| <span class="sd"> :param product_set_id: (Required) The resource id for the ProductSet to modify.</span> |
| <span class="sd"> :type product_set_id: str</span> |
| <span class="sd"> :param product_id: (Required) The resource id of this Product.</span> |
| <span class="sd"> :type product_id: str</span> |
| <span class="sd"> :param location: (Required) The region where the ProductSet is located. Valid regions (as of 2019-02-05)</span> |
| <span class="sd"> are: us-east1, us-west1, europe-west1, asia-east1</span> |
| <span class="sd"> :type: str</span> |
| <span class="sd"> :param project_id: (Optional) The project in which the Product is located. If set to None or</span> |
| <span class="sd"> missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: (Optional) The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each individual</span> |
| <span class="sd"> attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param metadata: (Optional) Additional metadata that is provided to the method.</span> |
| <span class="sd"> :type metadata: sequence[tuple[str, str]]</span> |
| <span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_remove_product_from_product_set_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionRemoveProductFromProductSetOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionRemoveProductFromProductSetOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"location"</span><span class="p">,</span> <span class="s2">"product_set_id"</span><span class="p">,</span> <span class="s2">"product_id"</span><span class="p">,</span> <span class="s2">"project_id"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_remove_product_from_product_set_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</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">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="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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionRemoveProductFromProductSetOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span> <span class="o">=</span> <span class="n">product_set_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">product_id</span> <span class="o">=</span> <span class="n">product_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| |
| <div class="viewcode-block" id="CloudVisionRemoveProductFromProductSetOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionRemoveProductFromProductSetOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">remove_product_from_product_set</span><span class="p">(</span> |
| <span class="n">product_set_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_set_id</span><span class="p">,</span> |
| <span class="n">product_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">product_id</span><span class="p">,</span> |
| <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionDetectTextOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectTextOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionDetectTextOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Detects Text in the image</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionDetectTextOperator`</span> |
| |
| <span class="sd"> :param image: (Required) The image to analyze. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :type image: dict or google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :param max_results: (Optional) Number of results to return.</span> |
| <span class="sd"> :type max_results: int</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: Number of seconds before timing out.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param language_hints: List of languages to use for TEXT_DETECTION.</span> |
| <span class="sd"> In most cases, an empty value yields the best results since it enables automatic language detection.</span> |
| <span class="sd"> For languages based on the Latin alphabet, setting language_hints is not needed.</span> |
| <span class="sd"> :type language_hints: str, list or google.cloud.vision.v1.ImageContext.language_hints:</span> |
| <span class="sd"> :param web_detection_params: Parameters for web detection.</span> |
| <span class="sd"> :type web_detection_params: dict or google.cloud.vision.v1.ImageContext.web_detection_params</span> |
| <span class="sd"> :param additional_properties: Additional properties to be set on the AnnotateImageRequest. See more:</span> |
| <span class="sd"> :class:`google.cloud.vision_v1.types.AnnotateImageRequest`</span> |
| <span class="sd"> :type additional_properties: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_detect_text_set_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionDetectTextOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectTextOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"image"</span><span class="p">,</span> <span class="s2">"max_results"</span><span class="p">,</span> <span class="s2">"timeout"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_detect_text_set_template_fields]</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">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">language_hints</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">web_detection_params</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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionDetectTextOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image</span> <span class="o">=</span> <span class="n">image</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">max_results</span> <span class="o">=</span> <span class="n">max_results</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span> <span class="o">=</span> <span class="n">kwargs</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span> <span class="o">=</span> <span class="n">prepare_additional_parameters</span><span class="p">(</span> |
| <span class="n">additional_properties</span><span class="o">=</span><span class="n">additional_properties</span><span class="p">,</span> |
| <span class="n">language_hints</span><span class="o">=</span><span class="n">language_hints</span><span class="p">,</span> |
| <span class="n">web_detection_params</span><span class="o">=</span><span class="n">web_detection_params</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionDetectTextOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectTextOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</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="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">additional_properties</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionDetectDocumentTextOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectDocumentTextOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionDetectDocumentTextOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Detects Document Text in the image</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionDetectDocumentTextOperator`</span> |
| |
| <span class="sd"> :param image: (Required) The image to analyze. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :type image: dict or google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :param max_results: Number of results to return.</span> |
| <span class="sd"> :type max_results: int</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: Number of seconds before timing out.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param language_hints: List of languages to use for TEXT_DETECTION.</span> |
| <span class="sd"> In most cases, an empty value yields the best results since it enables automatic language detection.</span> |
| <span class="sd"> For languages based on the Latin alphabet, setting language_hints is not needed.</span> |
| <span class="sd"> :type language_hints: str, list or google.cloud.vision.v1.ImageContext.language_hints:</span> |
| <span class="sd"> :param web_detection_params: Parameters for web detection.</span> |
| <span class="sd"> :type web_detection_params: dict or google.cloud.vision.v1.ImageContext.web_detection_params</span> |
| <span class="sd"> :param additional_properties: Additional properties to be set on the AnnotateImageRequest. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.AnnotateImageRequest</span> |
| <span class="sd"> :type additional_properties: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_document_detect_text_set_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionDetectDocumentTextOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectDocumentTextOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"image"</span><span class="p">,</span> <span class="s2">"max_results"</span><span class="p">,</span> <span class="s2">"timeout"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_document_detect_text_set_template_fields]</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">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">language_hints</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">web_detection_params</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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionDetectDocumentTextOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image</span> <span class="o">=</span> <span class="n">image</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">max_results</span> <span class="o">=</span> <span class="n">max_results</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span> <span class="o">=</span> <span class="n">prepare_additional_parameters</span><span class="p">(</span> |
| <span class="n">additional_properties</span><span class="o">=</span><span class="n">additional_properties</span><span class="p">,</span> |
| <span class="n">language_hints</span><span class="o">=</span><span class="n">language_hints</span><span class="p">,</span> |
| <span class="n">web_detection_params</span><span class="o">=</span><span class="n">web_detection_params</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudVisionDetectDocumentTextOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectDocumentTextOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</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="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">additional_properties</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionDetectImageLabelsOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageLabelsOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionDetectImageLabelsOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Detects Document Text in the image</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionDetectImageLabelsOperator`</span> |
| |
| <span class="sd"> :param image: (Required) The image to analyze. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :type image: dict or google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :param max_results: Number of results to return.</span> |
| <span class="sd"> :type max_results: int</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: Number of seconds before timing out.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param additional_properties: Additional properties to be set on the AnnotateImageRequest. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.AnnotateImageRequest</span> |
| <span class="sd"> :type additional_properties: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_detect_labels_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionDetectImageLabelsOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageLabelsOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"image"</span><span class="p">,</span> <span class="s2">"max_results"</span><span class="p">,</span> <span class="s2">"timeout"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_detect_labels_template_fields]</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionDetectImageLabelsOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image</span> <span class="o">=</span> <span class="n">image</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">max_results</span> <span class="o">=</span> <span class="n">max_results</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span> <span class="o">=</span> <span class="n">additional_properties</span> |
| |
| <div class="viewcode-block" id="CloudVisionDetectImageLabelsOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageLabelsOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</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="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">additional_properties</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="CloudVisionDetectImageSafeSearchOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageSafeSearchOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudVisionDetectImageSafeSearchOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Detects Document Text in the image</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudVisionDetectImageSafeSearchOperator`</span> |
| |
| <span class="sd"> :param image: (Required) The image to analyze. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :type image: dict or google.cloud.vision_v1.types.Image</span> |
| <span class="sd"> :param max_results: Number of results to return.</span> |
| <span class="sd"> :type max_results: int</span> |
| <span class="sd"> :param retry: (Optional) A retry object used to retry requests. If `None` is</span> |
| <span class="sd"> specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: Number of seconds before timing out.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :param additional_properties: Additional properties to be set on the AnnotateImageRequest. See more:</span> |
| <span class="sd"> https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.AnnotateImageRequest</span> |
| <span class="sd"> :type additional_properties: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START vision_detect_safe_search_template_fields]</span> |
| <div class="viewcode-block" id="CloudVisionDetectImageSafeSearchOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageSafeSearchOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"image"</span><span class="p">,</span> <span class="s2">"max_results"</span><span class="p">,</span> <span class="s2">"timeout"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">)</span></div> |
| <span class="c1"># [END vision_detect_safe_search_template_fields]</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudVisionDetectImageSafeSearchOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image</span> <span class="o">=</span> <span class="n">image</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">max_results</span> <span class="o">=</span> <span class="n">max_results</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span> <span class="o">=</span> <span class="n">additional_properties</span> |
| |
| <div class="viewcode-block" id="CloudVisionDetectImageSafeSearchOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageSafeSearchOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudVisionHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</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="bp">self</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="bp">self</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="bp">self</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="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span> |
| <span class="n">additional_properties</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">,</span></div></div> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="prepare_additional_parameters"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.prepare_additional_parameters">[docs]</a><span class="k">def</span> <span class="nf">prepare_additional_parameters</span><span class="p">(</span><span class="n">additional_properties</span><span class="p">,</span> <span class="n">language_hints</span><span class="p">,</span> <span class="n">web_detection_params</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates additional_properties parameter based on language_hints, web_detection_params and</span> |
| <span class="sd"> additional_properties parameters specified by the user</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">language_hints</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">web_detection_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">additional_properties</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="k">return</span> <span class="p">{}</span> |
| |
| <span class="n">merged_additional_parameters</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">additional_properties</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="s1">'image_context'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">merged_additional_parameters</span><span class="p">:</span> |
| <span class="n">merged_additional_parameters</span><span class="p">[</span><span class="s1">'image_context'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">merged_additional_parameters</span><span class="p">[</span><span class="s1">'image_context'</span><span class="p">][</span><span class="s1">'language_hints'</span><span class="p">]</span> <span class="o">=</span> <span class="n">merged_additional_parameters</span><span class="p">[</span> |
| <span class="s1">'image_context'</span> |
| <span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'language_hints'</span><span class="p">,</span> <span class="n">language_hints</span><span class="p">)</span> |
| <span class="n">merged_additional_parameters</span><span class="p">[</span><span class="s1">'image_context'</span><span class="p">][</span><span class="s1">'web_detection_params'</span><span class="p">]</span> <span class="o">=</span> <span class="n">merged_additional_parameters</span><span class="p">[</span> |
| <span class="s1">'image_context'</span> |
| <span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'web_detection_params'</span><span class="p">,</span> <span class="n">web_detection_params</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">merged_additional_parameters</span></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>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
