-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
87f261f
commit 36e1990
Showing
582 changed files
with
3,541 additions
and
386,877 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
213 changes: 8 additions & 205 deletions
213
latest/_modules/google/api_core/gapic_v1/client_info.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,205 +1,8 @@ | ||
|
||
<!DOCTYPE html> | ||
|
||
<html xmlns="http://www.w3.org/1999/xhtml"> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<title>google.api_core.gapic_v1.client_info — google-cloud 9289c52 documentation</title> | ||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" /> | ||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> | ||
<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> | ||
<link rel="shortcut icon" href="../../../../_static/favicon.ico"/> | ||
<link rel="index" title="Index" href="../../../../genindex.html" /> | ||
<link rel="search" title="Search" href="../../../../search.html" /> | ||
|
||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> | ||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> | ||
|
||
</head><body> | ||
|
||
|
||
<div class="document"> | ||
<div class="documentwrapper"> | ||
<div class="bodywrapper"> | ||
|
||
|
||
<div class="body" role="main"> | ||
|
||
<h1>Source code for google.api_core.gapic_v1.client_info</h1><div class="highlight"><pre> | ||
<span></span><span class="c1"># Copyright 2017 Google LLC</span> | ||
<span class="c1">#</span> | ||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span> | ||
<span class="c1"># you may not use this file except in compliance with the License.</span> | ||
<span class="c1"># 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, software</span> | ||
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> | ||
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> | ||
<span class="c1"># See the License for the specific language governing permissions and</span> | ||
<span class="c1"># limitations under the License.</span> | ||
|
||
<span class="sd">"""Helpers for providing client information.</span> | ||
|
||
<span class="sd">Client information is used to send information about the calling client,</span> | ||
<span class="sd">such as the library and Python version, to API services.</span> | ||
<span class="sd">"""</span> | ||
|
||
<span class="kn">from</span> <span class="nn">google.api_core</span> <span class="k">import</span> <span class="n">client_info</span> | ||
|
||
|
||
<span class="n">METRICS_METADATA_KEY</span> <span class="o">=</span> <span class="s2">"x-goog-api-client"</span> | ||
|
||
|
||
<div class="viewcode-block" id="ClientInfo"><a class="viewcode-back" href="../../../../core/client_info.html#google.api_core.gapic_v1.client_info.ClientInfo">[docs]</a><span class="k">class</span> <span class="nc">ClientInfo</span><span class="p">(</span><span class="n">client_info</span><span class="o">.</span><span class="n">ClientInfo</span><span class="p">):</span> | ||
<span class="sd">"""Client information used to generate a user-agent for API calls.</span> | ||
|
||
<span class="sd"> This user-agent information is sent along with API calls to allow the</span> | ||
<span class="sd"> receiving service to do analytics on which versions of Python and Google</span> | ||
<span class="sd"> libraries are being used.</span> | ||
|
||
<span class="sd"> Args:</span> | ||
<span class="sd"> python_version (str): The Python interpreter version, for example,</span> | ||
<span class="sd"> ``'2.7.13'``.</span> | ||
<span class="sd"> grpc_version (Optional[str]): The gRPC library version.</span> | ||
<span class="sd"> api_core_version (str): The google-api-core library version.</span> | ||
<span class="sd"> gapic_version (Optional[str]): The sversion of gapic-generated client</span> | ||
<span class="sd"> library, if the library was generated by gapic.</span> | ||
<span class="sd"> client_library_version (Optional[str]): The version of the client</span> | ||
<span class="sd"> library, generally used if the client library was not generated</span> | ||
<span class="sd"> by gapic or if additional functionality was built on top of</span> | ||
<span class="sd"> a gapic client library.</span> | ||
<span class="sd"> user_agent (Optional[str]): Prefix to the user agent header. This is</span> | ||
<span class="sd"> used to supply information such as application name or partner tool.</span> | ||
<span class="sd"> Recommended format: ``application-or-tool-ID/major.minor.version``.</span> | ||
<span class="sd"> """</span> | ||
|
||
<div class="viewcode-block" id="ClientInfo.to_grpc_metadata"><a class="viewcode-back" href="../../../../core/client_info.html#google.api_core.gapic_v1.client_info.ClientInfo.to_grpc_metadata">[docs]</a> <span class="k">def</span> <span class="nf">to_grpc_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | ||
<span class="sd">"""Returns the gRPC metadata for this client info."""</span> | ||
<span class="k">return</span> <span class="p">(</span><span class="n">METRICS_METADATA_KEY</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_user_agent</span><span class="p">())</span></div></div> | ||
|
||
|
||
<span class="n">DEFAULT_CLIENT_INFO</span> <span class="o">=</span> <span class="n">ClientInfo</span><span class="p">()</span> | ||
</pre></div> | ||
|
||
</div> | ||
|
||
</div> | ||
</div> | ||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | ||
<div class="sphinxsidebarwrapper"> | ||
<h1 class="logo"><a href="../../../../index.html">google-cloud</a></h1> | ||
|
||
|
||
|
||
<p class="blurb">Google Cloud Client Libraries for Python</p> | ||
|
||
|
||
|
||
|
||
<p> | ||
<iframe src="https://ghbtns.com/github-btn.html?user=GoogleCloudPlatform&repo=google-cloud-python&type=watch&count=true&size=large&v=2" | ||
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe> | ||
</p> | ||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3> | ||
<ul> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../core/index.html">Core Libraries</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../asset/index.html">Asset Management</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../automl/index.html">AutoML</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../bigquery/index.html">BigQuery</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../bigquery_datatransfer/index.html">BigQuery Data-Transfer</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../bigquery_storage/index.html">BigQuery Storage</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../bigtable/index.html">Bigtable</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../container/index.html">Container</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../containeranalysis/index.html">Container Analysis</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../datacatalog/index.html">Data Catalog</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../datalabeling/index.html">Data Labeling</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../dlp/index.html">Data Loss Prevention</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../dataproc/index.html">Dataproc</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../datastore/index.html">Datastore</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../dns/index.html">DNS</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../firestore/index.html">Firestore</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../grafeas/index.html">Grafeas</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../iam/index.html">IAM</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../iot/index.html">IoT</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../kms/index.html">Key Management</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../language/index.html">Natural Language</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../oslogin/index.html">OSLogin</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../pubsub/index.html">PubSub</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../redis/index.html">Memorystore</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../resource-manager/index.html">Resource Manager</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../runtimeconfig/index.html">Runtime Configuration</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler/index.html">Scheduler</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../securitycenter/index.html">Security Center</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../websecurityscanner/index.html">Security Scanner</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../spanner/index.html">Spanner</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../speech/index.html">Speech</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../error-reporting/index.html">Stackdriver Error Reporting</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../irm/index.html">Stackdriver Incident Response & Management</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../logging/index.html">Stackdriver Logging</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../monitoring/index.html">Stackdriver Monitoring</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../trace/index.html">Stackdriver Trace</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../storage/index.html">Storage</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../talent/index.html">Talent</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../tasks/index.html">Tasks</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../texttospeech/index.html">Text-to-Speech</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../translate/index.html">Translate</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../videointelligence/index.html">Video Intelligence</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../vision/index.html">Vision</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../webrisk/index.html">Web Risk</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../../releases.html">Release History</a></li> | ||
</ul> | ||
|
||
<div class="relations"> | ||
<h3>Related Topics</h3> | ||
<ul> | ||
<li><a href="../../../../index.html">Documentation overview</a><ul> | ||
<li><a href="../../../index.html">Module code</a><ul> | ||
</ul></li> | ||
</ul></li> | ||
</ul> | ||
</div> | ||
<div id="searchbox" style="display: none" role="search"> | ||
<h3 id="searchlabel">Quick search</h3> | ||
<div class="searchformwrapper"> | ||
<form class="search" action="../../../../search.html" method="get"> | ||
<input type="text" name="q" aria-labelledby="searchlabel" /> | ||
<input type="submit" value="Go" /> | ||
</form> | ||
</div> | ||
</div> | ||
<script type="text/javascript">$('#searchbox').show(0);</script> | ||
</div> | ||
</div> | ||
<div class="clearer"></div> | ||
</div> | ||
<div class="footer"> | ||
©2014-2017, Google. | ||
|
||
| | ||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a> | ||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | ||
|
||
</div> | ||
|
||
|
||
<a href="https://github.com/GoogleCloudPlatform/google-cloud-python" class="github"> | ||
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/> | ||
</a> | ||
|
||
|
||
|
||
</body> | ||
</html> | ||
<html> | ||
<head> | ||
<meta http-equiv="refresh" content="1; url=https://googleapis.dev/python/google-api-core/latest" /> | ||
<script> | ||
window.location.href = "https://googleapis.dev/python/google-api-core/latest" | ||
</script> | ||
</head> | ||
</html> |
Oops, something went wrong.