Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / logging_v2.projects.logs.html
blob: 1e1af12ddf7a6ec4025f1c9dd029051a9ad6f758 [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
75<h1><a href="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.logs.html">logs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]79<p class="firstline">Deletes all the log entries in a log. The log reappears if it receives new entries.</p>
80<p class="toc_element">
81 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
82<p class="firstline">Lists the logs in projects or organizations. Only logs that have entries are listed.</p>
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">
88 <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]89 <pre>Deletes all the log entries in a log. The log reappears if it receives new entries.
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:
93"projects/[PROJECT_ID]/logs/[LOG_ID]"
94"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
95[LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
100
101Returns:
102 An object of the form:
103
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]104 { # 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:
105 # service Foo {
106 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
107 # }
108 # The JSON representation for Empty is empty JSON object {}.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]109 }</pre>
110</div>
111
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]112<div class="method">
113 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
114 <pre>Lists the logs in projects or organizations. Only logs that have entries are listed.
115
116Args:
117 parent: string, Required. The resource name that owns the logs:
118"projects/[PROJECT_ID]"
119"organizations/[ORGANIZATION_ID]"
120 (required)
121 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.
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
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.
127
128Returns:
129 An object of the form:
130
131 { # Result returned from ListLogs.
132 "nextPageToken": "A String", # 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.
133 "logNames": [ # A list of log names. For example, "projects/my-project/syslog" or "organizations/123/cloudresourcemanager.googleapis.com%2Factivity".
134 "A String",
135 ],
136 }</pre>
137</div>
138
139<div class="method">
140 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
141 <pre>Retrieves the next page of results.
142
143Args:
144 previous_request: The request for the previous page. (required)
145 previous_response: The response from the request for the previous page. (required)
146
147Returns:
148 A request object that you can call 'execute()' on to request the next
149 page. Returns None if there are no more items in the collection.
150 </pre>
151</div>
152
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]153</body></html>