Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / logging_v2.projects.logs.html
blob: bb332befba6462305a6589c4f42f7d3c0e53d269 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]75<h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.logs.html">logs</a></h1>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#delete">delete(logName, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]79<p class="firstline">Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]81 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]88 <code class="details" id="delete">delete(logName, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]89 <pre>Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]90
91Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]92 logName: string, Required. The resource name of the log to delete:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]93&quot;projects/[PROJECT_ID]/logs/[LOG_ID]&quot;
94&quot;organizations/[ORGANIZATION_ID]/logs/[LOG_ID]&quot;
95&quot;billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]&quot;
96&quot;folders/[FOLDER_ID]/logs/[LOG_ID]&quot;
97[LOG_ID] must be URL-encoded. For example, &quot;projects/my-project-id/logs/syslog&quot;, &quot;organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity&quot;. For more information about log names, see LogEntry. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102
103Returns:
104 An object of the form:
105
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]106 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
107 # service Foo {
108 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
109 # }
110 # The JSON representation for Empty is empty JSON object {}.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]111 }</pre>
112</div>
113
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]114<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]115 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 <pre>Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]117
118Args:
119 parent: string, Required. The resource name that owns the logs:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]120&quot;projects/[PROJECT_ID]&quot;
121&quot;organizations/[ORGANIZATION_ID]&quot;
122&quot;billingAccounts/[BILLING_ACCOUNT_ID]&quot;
123&quot;folders/[FOLDER_ID]&quot;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]124 (required)
125 pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]126 pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]131
132Returns:
133 An object of the form:
134
135 { # Result returned from ListLogs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]136 &quot;logNames&quot;: [ # A list of log names. For example, &quot;projects/my-project/logs/syslog&quot; or &quot;organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity&quot;.
137 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]138 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]139 &quot;nextPageToken&quot;: &quot;A String&quot;, # If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
145 <pre>Retrieves the next page of results.
146
147Args:
148 previous_request: The request for the previous page. (required)
149 previous_response: The response from the request for the previous page. (required)
150
151Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]152 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]153 page. Returns None if there are no more items in the collection.
154 </pre>
155</div>
156
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]157</body></html>