forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlogging-entries.html
More file actions
301 lines (282 loc) · 19.4 KB
/
logging-entries.html
File metadata and controls
301 lines (282 loc) · 19.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Entries — gcloud 0.18.2 documentation</title>
<link rel="stylesheet" href="_static/css/main.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/normalize.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.18.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/js/vendor/modernizr-2.6.2.min.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="gcloud 0.18.2 documentation" href="index.html" />
<link rel="next" title="Metrics" href="logging-metric.html" />
<link rel="prev" title="Logger" href="logging-logger.html" />
</head>
<body role="document">
<header class="page-header fixed" role="banner">
<h1 class="logo">
<a href="index.html" title="back to home">
<img src="_static/images/logo.svg" alt="Google Cloud Platform" />
<span class="gcloud">gcloud</span>
</a>
</h1>
<nav class="main-nav">
<div class="nav-current">Python</div>
<ul class="menu">
<li>
<a href="http://googlecloudplatform.github.io/google-cloud-dotnet" title=".NET docs page">
<img src="_static/images/icon-lang-dotnet.svg" alt=".NET icon" class="menu-icon" />
.NET
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-java/" title="gcloud-java page">
<img src="_static/images/icon-lang-java-duke.svg" alt="Duke icon" class="menu-icon" />
Java
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-node/#/docs" title="Node.js docs page">
<img src="_static/images/icon-lang-nodejs.svg" alt="Node.js icon" class="menu-icon" />
Node.js
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-php/" title="PHP docs page">
<img src="_static/images/icon-lang-php.svg" alt="PHP icon" class="menu-icon" />
PHP
</a>
</li>
<li>
<a href="#" title="Python docs page">
<img src="_static/images/icon-lang-python.svg" alt="Python icon" class="menu-icon" />
Python
</a>
</li>
<li>
<a href="
http://googlecloudplatform.github.io/gcloud-ruby/docs/latest" title="Ruby docs page">
<img src="_static/images/icon-lang-ruby.svg" alt="Ruby icon" class="menu-icon" />
Ruby
</a>
</li>
</ul>
</nav><!-- end of .main-nav -->
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/new?title=%5BDocumentation+Issue%5D+&body=Page+Name%3A+logging-entries%0ARelease%3A%200.18.2" target="_blank" class="v-btn" id="file-issue">
<img src="_static/images/icon-link-github.svg" />
Report an Issue
</a>
</header><!-- end of .page-header -->
<article class="main lang-page" role="main">
<header class="docs-header">
<div class="versions">
<a href="/gcloud-python/versions.html" class="v-btn">
<img src="_static/images/icon-arrow-bullet.svg" />
Version History (0.18.2)
</a>
</div><!-- end of .versions -->
<div>
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/new?title=%5BDocumentation+Issue%5D+" target="_blank" class="v-btn" id="file-issue-secondary">
<img src="_static/images/icon-link-github.svg" />
Report an Issue
</a>
</div>
</header>
<section class="content">
<div class="section" id="module-gcloud.logging.entries">
<span id="entries"></span><h1>Entries<a class="headerlink" href="#module-gcloud.logging.entries" title="Permalink to this headline">#</a></h1>
<p>Log entries within the Google Stackdriver Logging API.</p>
<dl class="class">
<dt id="gcloud.logging.entries.ProtobufEntry">
<em class="property">class </em><code class="descclassname">gcloud.logging.entries.</code><code class="descname">ProtobufEntry</code><span class="sig-paren">(</span><em>payload</em>, <em>logger</em>, <em>insert_id=None</em>, <em>timestamp=None</em>, <em>labels=None</em>, <em>severity=None</em>, <em>http_request=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gcloud/logging/entries.html#ProtobufEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.logging.entries.ProtobufEntry" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">gcloud.logging.entries._BaseEntry</span></code></p>
<p>Entry created with <code class="docutils literal"><span class="pre">protoPayload</span></code>.</p>
<p>See:
<a class="reference external" href="https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry">https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry</a></p>
<dl class="method">
<dt id="gcloud.logging.entries.ProtobufEntry.parse_message">
<code class="descname">parse_message</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gcloud/logging/entries.html#ProtobufEntry.parse_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.logging.entries.ProtobufEntry.parse_message" title="Permalink to this definition">#</a></dt>
<dd><p>Parse payload into a protobuf message.</p>
<p>Mutates the passed-in <code class="docutils literal"><span class="pre">message</span></code> in place.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>Protobuf message</em>) – the message to be logged</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="gcloud.logging.entries.StructEntry">
<em class="property">class </em><code class="descclassname">gcloud.logging.entries.</code><code class="descname">StructEntry</code><span class="sig-paren">(</span><em>payload</em>, <em>logger</em>, <em>insert_id=None</em>, <em>timestamp=None</em>, <em>labels=None</em>, <em>severity=None</em>, <em>http_request=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gcloud/logging/entries.html#StructEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.logging.entries.StructEntry" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">gcloud.logging.entries._BaseEntry</span></code></p>
<p>Entry created with <code class="docutils literal"><span class="pre">jsonPayload</span></code>.</p>
<p>See:
<a class="reference external" href="https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry">https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry</a></p>
</dd></dl>
<dl class="class">
<dt id="gcloud.logging.entries.TextEntry">
<em class="property">class </em><code class="descclassname">gcloud.logging.entries.</code><code class="descname">TextEntry</code><span class="sig-paren">(</span><em>payload</em>, <em>logger</em>, <em>insert_id=None</em>, <em>timestamp=None</em>, <em>labels=None</em>, <em>severity=None</em>, <em>http_request=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gcloud/logging/entries.html#TextEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.logging.entries.TextEntry" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">gcloud.logging.entries._BaseEntry</span></code></p>
<p>Entry created with <code class="docutils literal"><span class="pre">textPayload</span></code>.</p>
<p>See:
<a class="reference external" href="https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry">https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry</a></p>
</dd></dl>
<dl class="function">
<dt id="gcloud.logging.entries.logger_name_from_path">
<code class="descclassname">gcloud.logging.entries.</code><code class="descname">logger_name_from_path</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gcloud/logging/entries.html#logger_name_from_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.logging.entries.logger_name_from_path" title="Permalink to this definition">#</a></dt>
<dd><p>Validate a logger URI path and get the logger name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – URI path for a logger API request.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Logger name parsed from <code class="docutils literal"><span class="pre">path</span></code>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">ValueError</span></code> if the <code class="docutils literal"><span class="pre">path</span></code> is ill-formed or if
the project from the <code class="docutils literal"><span class="pre">path</span></code> does not agree with the
<code class="docutils literal"><span class="pre">project</span></code> passed in.</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</section><!-- end of .content -->
<nav class="side-nav">
<p class="caption"><span class="caption-text">gcloud</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="gcloud-api.html">Shared Core Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="gcloud-config.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="gcloud-auth.html">Authentication</a></li>
</ul>
<p class="caption"><span class="caption-text">Datastore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="datastore-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="datastore-entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="datastore-keys.html">Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="datastore-queries.html">Queries</a></li>
<li class="toctree-l1"><a class="reference internal" href="datastore-transactions.html">Transactions</a></li>
<li class="toctree-l1"><a class="reference internal" href="datastore-batches.html">Batches</a></li>
<li class="toctree-l1"><a class="reference internal" href="datastore-helpers.html">Helpers</a></li>
</ul>
<p class="caption"><span class="caption-text">Storage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="storage-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="storage-blobs.html">Blobs / Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="storage-buckets.html">Buckets</a></li>
<li class="toctree-l1"><a class="reference internal" href="storage-acl.html">ACL</a></li>
<li class="toctree-l1"><a class="reference internal" href="storage-batch.html">Batches</a></li>
</ul>
<p class="caption"><span class="caption-text">Pub/Sub</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pubsub-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubsub-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubsub-topic.html">Topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubsub-subscription.html">Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubsub-message.html">Message</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubsub-iam.html">IAM Policy</a></li>
</ul>
<p class="caption"><span class="caption-text">BigQuery</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bigquery-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigquery-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigquery-dataset.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigquery-job.html">Jobs</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigquery-table.html">Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigquery-query.html">Query</a></li>
</ul>
<p class="caption"><span class="caption-text">Cloud Bigtable</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bigtable-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="happybase-package.html">HappyBase</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-client-intro.html">Base for Everything</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-instance-api.html">Instance Admin API</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-table-api.html">Table Admin API</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-data-api.html">Data API</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-instance.html">Instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-cluster.html">Cluster</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-table.html">Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-column-family.html">Column Families</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-row.html">Bigtable Row</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-row-filters.html">Bigtable Row Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigtable-row-data.html">Row Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="happybase-connection.html">HappyBase Connection</a></li>
<li class="toctree-l1"><a class="reference internal" href="happybase-pool.html">HappyBase Connection Pool</a></li>
<li class="toctree-l1"><a class="reference internal" href="happybase-table.html">HappyBase Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="happybase-batch.html">HappyBase Batch</a></li>
</ul>
<p class="caption"><span class="caption-text">Resource Manager</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="resource-manager-api.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="resource-manager-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="resource-manager-project.html">Projects</a></li>
</ul>
<p class="caption"><span class="caption-text">DNS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dns-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="dns-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="dns-zone.html">Managed Zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="dns-resource-record-set.html">Resource Record Sets</a></li>
<li class="toctree-l1"><a class="reference internal" href="dns-changes.html">Change Sets</a></li>
</ul>
<p class="caption"><span class="caption-text">Stackdriver Logging</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="logging-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging-logger.html">Logger</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Entries</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging-metric.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging-sink.html">Sinks</a></li>
</ul>
<p class="caption"><span class="caption-text">Stackdriver Error Reporting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="error-reporting-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="error-reporting-client.html">Client</a></li>
</ul>
<p class="caption"><span class="caption-text">Stackdriver Monitoring</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="monitoring-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring-metric.html">Metric Descriptors</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring-resource.html">Monitored Resource Descriptors</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring-query.html">Time Series Query</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring-timeseries.html">Time Series</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring-label.html">Label Descriptors</a></li>
</ul>
<p class="caption"><span class="caption-text">Translate</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="translate-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="translate-client.html">Client</a></li>
</ul>
<p class="caption"><span class="caption-text">External Links</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/GoogleCloudPlatform/gcloud-python/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/GoogleCloudPlatform/gcloud-python/issues">Issues</a></li>
<li class="toctree-l1"><a class="reference external" href="http://stackoverflow.com/questions/tagged/gcloud-python">Stack Overflow</a></li>
<li class="toctree-l1"><a class="reference external" href="https://pypi.python.org/pypi/gcloud">PyPI</a></li>
</ul>
</nav><!-- end of .side-nav -->
</article><!-- end of .main -->
<script src="_static/js/vendor/jquery-1.10.2.min.js"></script>
<script src="_static/js/plugins.js"></script>
<script src="_static/js/main.js"></script>
</body>
</html>