• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">Cloud Logging API</a> . <a href="logging_v2.organizations.html">organizations</a> . <a href="logging_v2.organizations.locations.html">locations</a> . <a href="logging_v2.organizations.locations.buckets.html">buckets</a> . <a href="logging_v2.organizations.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>
82<p class="firstline">Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.</p>
83<p class="toc_element">
84  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.</p>
86<p class="toc_element">
87  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets a view on a log bucket..</p>
89<p class="toc_element">
90  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists views on a log bucket.</p>
92<p class="toc_element">
93  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97<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. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="close">close()</code>
101  <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105    <code class="details" id="create">create(parent, body=None, viewId=None, x__xgafv=None)</code>
106  <pre>Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
107
108Args:
109  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)
110  body: object, The request body.
111    The object takes the form of:
112
113{ # Describes a view over log entries in a bucket.
114  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
115  &quot;description&quot;: &quot;A String&quot;, # Describes this view.
116  &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;)
117  &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
118  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
119}
120
121  viewId: string, Required. The id to use for this view.
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    { # Describes a view over log entries in a bucket.
131  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
132  &quot;description&quot;: &quot;A String&quot;, # Describes this view.
133  &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;)
134  &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
135  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
136}</pre>
137</div>
138
139<div class="method">
140    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
141  <pre>Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.
142
143Args:
144  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)
145  x__xgafv: string, V1 error format.
146    Allowed values
147      1 - v1 error format
148      2 - v2 error format
149
150Returns:
151  An object of the form:
152
153    { # 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 {}.
154}</pre>
155</div>
156
157<div class="method">
158    <code class="details" id="get">get(name, x__xgafv=None)</code>
159  <pre>Gets a view on a log bucket..
160
161Args:
162  name: string, Required. The resource name of the policy: &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)
163  x__xgafv: string, V1 error format.
164    Allowed values
165      1 - v1 error format
166      2 - v2 error format
167
168Returns:
169  An object of the form:
170
171    { # Describes a view over log entries in a bucket.
172  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
173  &quot;description&quot;: &quot;A String&quot;, # Describes this view.
174  &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;)
175  &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
176  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
177}</pre>
178</div>
179
180<div class="method">
181    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
182  <pre>Lists views on a log bucket.
183
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)
186  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.
187  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.
188  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.
197  &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.
199    { # Describes a view over log entries in a bucket.
200      &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.
202      &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
204      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
205    },
206  ],
207}</pre>
208</div>
209
210<div class="method">
211    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
212  <pre>Retrieves the next page of results.
213
214Args:
215  previous_request: The request for the previous page. (required)
216  previous_response: The response from the request for the previous page. (required)
217
218Returns:
219  A request object that you can call &#x27;execute()&#x27; on to request the next
220  page. Returns None if there are no more items in the collection.
221    </pre>
222</div>
223
224<div class="method">
225    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
226  <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. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.
227
228Args:
229  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)
230  body: object, The request body.
231    The object takes the form of:
232
233{ # Describes a view over log entries in a bucket.
234  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
235  &quot;description&quot;: &quot;A String&quot;, # Describes this view.
236  &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;)
237  &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
238  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
239}
240
241  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
242  x__xgafv: string, V1 error format.
243    Allowed values
244      1 - v1 error format
245      2 - v2 error format
246
247Returns:
248  An object of the form:
249
250    { # Describes a view over log entries in a bucket.
251  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
252  &quot;description&quot;: &quot;A String&quot;, # Describes this view.
253  &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;)
254  &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
255  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
256}</pre>
257</div>
258
259</body></html>