Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d976781ea71d0decea37b297b743f81ccc456ecf / . / docs / dyn / logging_v1beta3.projects.logs.html
blob: c8316e93ddf33abb14c3807ddf3208fa213d4e38 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logs.html">logs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="logging_v1beta3.projects.logs.entries.html">entries()</a></code>
79</p>
80<p class="firstline">Returns the entries Resource.</p>
81
82<p class="toc_element">
83 <code><a href="logging_v1beta3.projects.logs.sinks.html">sinks()</a></code>
84</p>
85<p class="firstline">Returns the sinks Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#delete">delete(projectsId, logsId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89<p class="firstline">Deletes a log and all its log entries. The log will reappear if it receives new entries.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]90<p class="toc_element">
91 <code><a href="#list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92<p class="firstline">Lists the logs in the project. Only logs that have entries are listed.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
98 <code class="details" id="delete">delete(projectsId, logsId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]99 <pre>Deletes a log and all its log entries. The log will reappear if it receives new entries.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]100
101Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]102 projectsId: string, Part of `logName`. The resource name of the log to be deleted. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]103 logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
104 x__xgafv: string, V1 error format.
105
106Returns:
107 An object of the form:
108
Takashi Matsuo06694102015-09-11 13:55:40 -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 `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]110 }</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115 <pre>Lists the logs in the project. Only logs that have entries are listed.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]116
117Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]118 projectsId: string, Part of `projectName`. The resource name of the project whose logs are requested. If both `serviceName` and `serviceIndexPrefix` are empty, then all logs with entries in this project are listed. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]119 pageSize: integer, The maximum number of results to return.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120 serviceName: string, If not empty, this field must be a log service name such as `"compute.googleapis.com"`. Only logs associated with that that log service are listed.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]121 pageToken: string, An opaque token, returned as `nextPageToken` by a prior `ListLogs` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogs` operation is continued.
122 x__xgafv: string, V1 error format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]123 serviceIndexPrefix: string, The purpose of this field is to restrict the listed logs to those with entries of a certain kind. If `serviceName` is the name of a log service, then this field may contain values for the log service's indexes. Only logs that have entries whose indexes include the values are listed. The format for this field is `"/val1/val2.../valN"`, where `val1` is a value for the first index, `val2` for the second index, etc. An empty value (a single slash) for an index matches all values, and you can omit values for later indexes entirely.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]124
125Returns:
126 An object of the form:
127
128 { # Result returned from ListLogs.
129 "nextPageToken": "A String", # If there are more results, then `nextPageToken` is returned in the response. To get the next batch of logs, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogs`. If `nextPageToken` is empty, then there are no more results.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]130 "logs": [ # A list of log descriptions matching the criteria.
131 { # _Output only._ Describes a log, which is a named stream of log entries.
132 "payloadType": "A String", # _Optional_. A URI representing the expected payload type for log entries.
133 "displayName": "A String", # _Optional._ The common name of the log. Example: `"request_log"`.
134 "name": "A String", # The resource name of the log. Example: `"/projects/my-gcp-project-id/logs/LOG_NAME"`, where `LOG_NAME` is the URL-encoded given name of the log. The log includes those log entries whose `LogEntry.log` field contains this given name. To avoid name collisions, it is a best practice to prefix the given log name with the service name, but this is not required. Examples of log given names: `"appengine.googleapis.com/request_log"`, `"apache-access"`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]135 },
136 ],
137 }</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
142 <pre>Retrieves the next page of results.
143
144Args:
145 previous_request: The request for the previous page. (required)
146 previous_response: The response from the request for the previous page. (required)
147
148Returns:
149 A request object that you can call 'execute()' on to request the next
150 page. Returns None if there are no more items in the collection.
151 </pre>
152</div>
153
154</body></html>