File: logging_v2.billingAccounts.locations.buckets.views.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (264 lines) | stat: -rw-r--r-- 15,682 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="logging_v2.billingAccounts.locations.buckets.views.logs.html">logs()</a></code>
</p>
<p class="firstline">Returns the logs Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, viewId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a view on a log bucket.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists views on a log bucket.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. 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>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, viewId=None, x__xgafv=None)</code>
  <pre>Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # Describes a view over log entries in a bucket.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Describes this view.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND NOT LOG_ID(&quot;stdout&quot;)
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
}

  viewId: string, Required. A client-assigned identifier such as &quot;my-view&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a view over log entries in a bucket.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Describes this view.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND NOT LOG_ID(&quot;stdout&quot;)
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <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.

Args:
  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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a view on a log bucket.

Args:
  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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a view over log entries in a bucket.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Describes this view.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND NOT LOG_ID(&quot;stdout&quot;)
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists views on a log bucket.

Args:
  parent: string, Required. The bucket whose views are to be listed: &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot;  (required)
  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.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response from ListViews.
  &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.
  &quot;views&quot;: [ # A list of views.
    { # Describes a view over log entries in a bucket.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
      &quot;description&quot;: &quot;A String&quot;, # Optional. Describes this view.
      &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND NOT LOG_ID(&quot;stdout&quot;)
      &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. 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.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # Describes a view over log entries in a bucket.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Describes this view.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND NOT LOG_ID(&quot;stdout&quot;)
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
}

  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
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a view over log entries in a bucket.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the view.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Describes this view.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE(&quot;projects/myproject&quot;) AND resource.type = &quot;gce_instance&quot; AND NOT LOG_ID(&quot;stdout&quot;)
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the view.
}</pre>
</div>

</body></html>