Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / logging_v2.logs.html
blob: 83cab718894ca72cc8fde68fbfc7ded0cebde0d4 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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.logs.html">logs</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#delete">delete(logName, x__xgafv=None)</a></code></p>
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]82<p class="firstline">Deletes all the log entries in a log for the _Default Log Bucket. 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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, resourceNames=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 <code class="details" id="delete">delete(logName, x__xgafv=None)</code>
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]97 <pre>Deletes all the log entries in a log for the _Default Log Bucket. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98
99Args:
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]100 logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, &quot;projects/my-project-id/logs/syslog&quot;, &quot;organizations/123/logs/cloudaudit.googleapis.com%2Factivity&quot;.For more information about log names, see LogEntry. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 { # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]110}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111</div>
112
113<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]114 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, resourceNames=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 <pre>Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
116
117Args:
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]118 parent: string, Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]119 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]120 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.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]121 resourceNames: string, Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (repeated)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
130 { # Result returned from ListLogs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]131 &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;.
132 &quot;A String&quot;,
133 ],
134 &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.
135}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136</div>
137
138<div class="method">
139 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
140 <pre>Retrieves the next page of results.
141
142Args:
143 previous_request: The request for the previous page. (required)
144 previous_response: The response from the request for the previous page. (required)
145
146Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 page. Returns None if there are no more items in the collection.
149 </pre>
150</div>
151
152</body></html>