blob: 6beadf0f84f4bf939a08a6ebbe8d1ba597db5e85 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070078 <code><a href="logging_v2.billingAccounts.locations.buckets.views.html">views()</a></code>
79</p>
80<p class="firstline">Returns the views Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#create">create(parent, body=None, bucketId=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted.</p>
91<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080092 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070093<p class="firstline">Lists buckets.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070094<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
98 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070099<p class="firstline">Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<p class="toc_element">
101 <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700103<h3>Method Details</h3>
104<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="create">create(parent, body=None, bucketId=None, x__xgafv=None)</code>
111 <pre>Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.
112
113Args:
114 parent: string, Required. The resource in which to create the bucket: &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]&quot; Example: &quot;projects/my-logging-project/locations/global&quot; (required)
115 body: object, The request body.
116 The object takes the form of:
117
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700118{ # Describes a repository of logs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800119 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
121 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
122 &quot;locked&quot;: True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
yoshi-code-bot69706592021-03-03 03:54:02 -0800123 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket. For example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot; The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700124 &quot;restrictedFields&quot;: [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz.
125 &quot;A String&quot;,
126 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800127 &quot;retentionDays&quot;: 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
128 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129}
130
131 bucketId: string, Required. A client-assigned identifier such as &quot;my-bucket&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700140 { # Describes a repository of logs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
142 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
143 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
144 &quot;locked&quot;: True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
yoshi-code-bot69706592021-03-03 03:54:02 -0800145 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket. For example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot; The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700146 &quot;restrictedFields&quot;: [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz.
147 &quot;A String&quot;,
148 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800149 &quot;retentionDays&quot;: 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
150 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
151}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152</div>
153
154<div class="method">
155 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
156 <pre>Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted.
157
158Args:
159 name: string, Required. The full resource name of the bucket to delete. &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; Example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot;. (required)
160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165Returns:
166 An object of the form:
167
168 { # 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 -0800169}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700170</div>
171
172<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800173 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700174 <pre>Lists buckets.
Bu Sun Kim65020912020-05-20 12:08:20 -0700175
176Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700177 parent: string, Required. The parent resource whose buckets are to be listed: &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]&quot; &quot;folders/[FOLDER_ID]/locations/[LOCATION_ID]&quot; Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800178 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 Bot0bf565c2020-12-09 08:56:03 -0800179 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 Kim65020912020-05-20 12:08:20 -0700180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700188 { # The response from ListBuckets.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800189 &quot;buckets&quot;: [ # A list of buckets.
190 { # Describes a repository of logs.
191 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
192 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
193 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
194 &quot;locked&quot;: True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
yoshi-code-bot69706592021-03-03 03:54:02 -0800195 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket. For example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot; The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700196 &quot;restrictedFields&quot;: [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz.
197 &quot;A String&quot;,
198 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800199 &quot;retentionDays&quot;: 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
200 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
201 },
202 ],
203 &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.
204}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700205</div>
206
207<div class="method">
208 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
209 <pre>Retrieves the next page of results.
210
211Args:
212 previous_request: The request for the previous page. (required)
213 previous_response: The response from the request for the previous page. (required)
214
215Returns:
216 A request object that you can call &#x27;execute()&#x27; on to request the next
217 page. Returns None if there are no more items in the collection.
218 </pre>
219</div>
220
221<div class="method">
222 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700223 <pre>Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700224
225Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700226 name: string, Required. The full resource name of the bucket to update. &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; Example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot;. Also requires permission &quot;resourcemanager.projects.updateLiens&quot; to set the locked property (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700227 body: object, The request body.
228 The object takes the form of:
229
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700230{ # Describes a repository of logs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800231 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800232 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
233 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
234 &quot;locked&quot;: True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
yoshi-code-bot69706592021-03-03 03:54:02 -0800235 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket. For example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot; The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700236 &quot;restrictedFields&quot;: [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz.
237 &quot;A String&quot;,
238 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800239 &quot;retentionDays&quot;: 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
240 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Bu Sun Kim65020912020-05-20 12:08:20 -0700241}
242
243 updateMask: string, Required. Field mask that specifies the fields in bucket that need an update. A bucket 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.FieldMaskExample: updateMask=retention_days.
244 x__xgafv: string, V1 error format.
245 Allowed values
246 1 - v1 error format
247 2 - v2 error format
248
249Returns:
250 An object of the form:
251
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700252 { # Describes a repository of logs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800253 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
254 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
255 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
256 &quot;locked&quot;: True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
yoshi-code-bot69706592021-03-03 03:54:02 -0800257 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket. For example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot; The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700258 &quot;restrictedFields&quot;: [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz.
259 &quot;A String&quot;,
260 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800261 &quot;retentionDays&quot;: 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
262 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
263}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700264</div>
265
266<div class="method">
267 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
268 <pre>Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.
269
270Args:
271 name: string, Required. The full resource name of the bucket to undelete. &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; &quot;folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]&quot; Example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot;. (required)
272 body: object, The request body.
273 The object takes the form of:
274
275{ # The parameters to UndeleteBucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800276}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700277
278 x__xgafv: string, V1 error format.
279 Allowed values
280 1 - v1 error format
281 2 - v2 error format
282
283Returns:
284 An object of the form:
285
286 { # 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 -0800287}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700288</div>
289
290</body></html>