blob: dba4a1d15ba567300fcec5869f2512c8c1583be7 [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001<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">Cloud Logging API</a> . <a href="logging_v2.billingAccounts.html">billingAccounts</a> . <a href="logging_v2.billingAccounts.locations.html">locations</a> . <a href="logging_v2.billingAccounts.locations.buckets.html">buckets</a> . <a href="logging_v2.billingAccounts.locations.buckets.views.html">views</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body=None, viewId=None, x__xgafv=None)</a></code></p>
yoshi-code-bot8bb904c2021-08-31 00:28:27 -070082<p class="firstline">Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.</p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070083<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070085<p class="firstline">Deletes a view on a log bucket.</p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070086<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080087 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070088<p class="firstline">Lists views on a log bucket.</p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070094<p class="firstline">Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter.</p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070095<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, viewId=None, x__xgafv=None)</code>
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700103 <pre>Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700104
105Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700106 parent: string, Required. The bucket in which to create the view `&quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot;` For example:&quot;projects/my-project/locations/global/buckets/my-bucket&quot; (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700107 body: object, The request body.
108 The object takes the form of:
109
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700110{ # Describes a view over log entries in a bucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800111 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800112 &quot;description&quot;: &quot;A String&quot;, # Describes this view.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700113 &quot;filter&quot;: &quot;A String&quot;, # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND LOG_ID(&quot;stdout&quot;)
114 &quot;name&quot;: &quot;A String&quot;, # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700115 &quot;schema&quot;: { # Schema of a table containing logs. # Describes the schema of the logs stored in the bucket that are accessible via this view.This field is only populated for views in analytics-enabled buckets.
116 &quot;fields&quot;: [ # Describes the fields in a table.
117 { # A field in TableSchema. The fields describe the static fields in the LogEntry. Any dynamic fields generated by the customer in fields like labels and jsonPayload are not listed in the schema as they use a native JSON type field.
118 &quot;description&quot;: &quot;A String&quot;, # Optional. The field description.
119 &quot;fields&quot;: [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
120 # Object with schema name: TableFieldSchema
121 ],
122 &quot;mode&quot;: &quot;A String&quot;, # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
123 &quot;name&quot;: &quot;A String&quot;, # Required. The field name corresponding to fields in the LogEntry.
124 &quot;type&quot;: &quot;A String&quot;, # Required. The field data type. Possible values include: STRING INTEGER (or INT64) FLOAT (or FLOAT64) BOOLEAN (or BOOL) TIMESTAMP RECORD (or STRUCT)Use of RECORD/STRUT indicates that the field contains a nested schema.
125 },
126 ],
127 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700129}
130
131 viewId: string, Required. The id to use for this view.
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700140 { # Describes a view over log entries in a bucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
142 &quot;description&quot;: &quot;A String&quot;, # Describes this view.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700143 &quot;filter&quot;: &quot;A String&quot;, # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND LOG_ID(&quot;stdout&quot;)
144 &quot;name&quot;: &quot;A String&quot;, # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700145 &quot;schema&quot;: { # Schema of a table containing logs. # Describes the schema of the logs stored in the bucket that are accessible via this view.This field is only populated for views in analytics-enabled buckets.
146 &quot;fields&quot;: [ # Describes the fields in a table.
147 { # A field in TableSchema. The fields describe the static fields in the LogEntry. Any dynamic fields generated by the customer in fields like labels and jsonPayload are not listed in the schema as they use a native JSON type field.
148 &quot;description&quot;: &quot;A String&quot;, # Optional. The field description.
149 &quot;fields&quot;: [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
150 # Object with schema name: TableFieldSchema
151 ],
152 &quot;mode&quot;: &quot;A String&quot;, # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
153 &quot;name&quot;: &quot;A String&quot;, # Required. The field name corresponding to fields in the LogEntry.
154 &quot;type&quot;: &quot;A String&quot;, # Required. The field data type. Possible values include: STRING INTEGER (or INT64) FLOAT (or FLOAT64) BOOLEAN (or BOOL) TIMESTAMP RECORD (or STRUCT)Use of RECORD/STRUT indicates that the field contains a nested schema.
155 },
156 ],
157 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800158 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
159}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700160</div>
161
162<div class="method">
163 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700164 <pre>Deletes a view on a log bucket.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700165
166Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700167 name: string, Required. The full resource name of the view to delete: &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]&quot; For example:&quot;projects/my-project/locations/global/buckets/my-bucket/views/my-view&quot; (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
176 { # 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 -0800177}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700178</div>
179
180<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800181 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700182 <pre>Lists views on a log bucket.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700183
184Args:
185 parent: string, Required. The bucket whose views are to be listed: &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; (required)
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700186 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 -0800187 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 Kim673ec5c2020-11-16 11:05:03 -0700188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
196 { # The response from ListViews.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800197 &quot;nextPageToken&quot;: &quot;A String&quot;, # If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
198 &quot;views&quot;: [ # A list of views.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700199 { # Describes a view over log entries in a bucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800200 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
201 &quot;description&quot;: &quot;A String&quot;, # Describes this view.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700202 &quot;filter&quot;: &quot;A String&quot;, # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND LOG_ID(&quot;stdout&quot;)
203 &quot;name&quot;: &quot;A String&quot;, # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700204 &quot;schema&quot;: { # Schema of a table containing logs. # Describes the schema of the logs stored in the bucket that are accessible via this view.This field is only populated for views in analytics-enabled buckets.
205 &quot;fields&quot;: [ # Describes the fields in a table.
206 { # A field in TableSchema. The fields describe the static fields in the LogEntry. Any dynamic fields generated by the customer in fields like labels and jsonPayload are not listed in the schema as they use a native JSON type field.
207 &quot;description&quot;: &quot;A String&quot;, # Optional. The field description.
208 &quot;fields&quot;: [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
209 # Object with schema name: TableFieldSchema
210 ],
211 &quot;mode&quot;: &quot;A String&quot;, # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
212 &quot;name&quot;: &quot;A String&quot;, # Required. The field name corresponding to fields in the LogEntry.
213 &quot;type&quot;: &quot;A String&quot;, # Required. The field data type. Possible values include: STRING INTEGER (or INT64) FLOAT (or FLOAT64) BOOLEAN (or BOOL) TIMESTAMP RECORD (or STRUCT)Use of RECORD/STRUT indicates that the field contains a nested schema.
214 },
215 ],
216 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800217 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
218 },
219 ],
220}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700221</div>
222
223<div class="method">
224 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
225 <pre>Retrieves the next page of results.
226
227Args:
228 previous_request: The request for the previous page. (required)
229 previous_response: The response from the request for the previous page. (required)
230
231Returns:
232 A request object that you can call &#x27;execute()&#x27; on to request the next
233 page. Returns None if there are no more items in the collection.
234 </pre>
235</div>
236
237<div class="method">
238 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700239 <pre>Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700240
241Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700242 name: string, Required. The full resource name of the view to update &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]&quot; For example:&quot;projects/my-project/locations/global/buckets/my-bucket/views/my-view&quot; (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700243 body: object, The request body.
244 The object takes the form of:
245
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700246{ # Describes a view over log entries in a bucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800247 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800248 &quot;description&quot;: &quot;A String&quot;, # Describes this view.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700249 &quot;filter&quot;: &quot;A String&quot;, # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND LOG_ID(&quot;stdout&quot;)
250 &quot;name&quot;: &quot;A String&quot;, # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700251 &quot;schema&quot;: { # Schema of a table containing logs. # Describes the schema of the logs stored in the bucket that are accessible via this view.This field is only populated for views in analytics-enabled buckets.
252 &quot;fields&quot;: [ # Describes the fields in a table.
253 { # A field in TableSchema. The fields describe the static fields in the LogEntry. Any dynamic fields generated by the customer in fields like labels and jsonPayload are not listed in the schema as they use a native JSON type field.
254 &quot;description&quot;: &quot;A String&quot;, # Optional. The field description.
255 &quot;fields&quot;: [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
256 # Object with schema name: TableFieldSchema
257 ],
258 &quot;mode&quot;: &quot;A String&quot;, # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
259 &quot;name&quot;: &quot;A String&quot;, # Required. The field name corresponding to fields in the LogEntry.
260 &quot;type&quot;: &quot;A String&quot;, # Required. The field data type. Possible values include: STRING INTEGER (or INT64) FLOAT (or FLOAT64) BOOLEAN (or BOOL) TIMESTAMP RECORD (or STRUCT)Use of RECORD/STRUT indicates that the field contains a nested schema.
261 },
262 ],
263 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800264 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700265}
266
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700267 updateMask: string, Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700268 x__xgafv: string, V1 error format.
269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
272
273Returns:
274 An object of the form:
275
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700276 { # Describes a view over log entries in a bucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800277 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
278 &quot;description&quot;: &quot;A String&quot;, # Describes this view.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700279 &quot;filter&quot;: &quot;A String&quot;, # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND LOG_ID(&quot;stdout&quot;)
280 &quot;name&quot;: &quot;A String&quot;, # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700281 &quot;schema&quot;: { # Schema of a table containing logs. # Describes the schema of the logs stored in the bucket that are accessible via this view.This field is only populated for views in analytics-enabled buckets.
282 &quot;fields&quot;: [ # Describes the fields in a table.
283 { # A field in TableSchema. The fields describe the static fields in the LogEntry. Any dynamic fields generated by the customer in fields like labels and jsonPayload are not listed in the schema as they use a native JSON type field.
284 &quot;description&quot;: &quot;A String&quot;, # Optional. The field description.
285 &quot;fields&quot;: [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
286 # Object with schema name: TableFieldSchema
287 ],
288 &quot;mode&quot;: &quot;A String&quot;, # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
289 &quot;name&quot;: &quot;A String&quot;, # Required. The field name corresponding to fields in the LogEntry.
290 &quot;type&quot;: &quot;A String&quot;, # Required. The field data type. Possible values include: STRING INTEGER (or INT64) FLOAT (or FLOAT64) BOOLEAN (or BOOL) TIMESTAMP RECORD (or STRUCT)Use of RECORD/STRUT indicates that the field contains a nested schema.
291 },
292 ],
293 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800294 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
295}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700296</div>
297
298</body></html>