blob: 6d950fa52c579203884c530e51d7c82e5c0c45cf [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.locations.html">locations</a> . <a href="logging_v2.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.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>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070087<p class="firstline">Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070090<p class="firstline">Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070092 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070093<p class="firstline">Gets a log bucket.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070094<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080095 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070096<p class="firstline">Lists log buckets.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070097<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700102<p class="firstline">Updates a log 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 lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103<p class="toc_element">
104 <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700105<p class="firstline">Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700106<h3>Method Details</h3>
107<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="create">create(parent, body=None, bucketId=None, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700114 <pre>Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket&#x27;s location cannot be changed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700115
116Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700117 parent: string, Required. The resource in which to create the log bucket: &quot;projects/[PROJECT_ID]/locations/[LOCATION_ID]&quot; For example:&quot;projects/my-project/locations/global&quot; (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700118 body: object, The request body.
119 The object takes the form of:
120
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700121{ # Describes a repository in which log entries are stored.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800122 &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 -0800123 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
124 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700125 &quot;locked&quot;: True or False, # Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
126 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
127 &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)
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700128 &quot;A String&quot;,
129 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 &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.
131 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700132}
133
134 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700143 { # Describes a repository in which log entries are stored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 &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.
145 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
146 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700147 &quot;locked&quot;: True or False, # Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
148 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
149 &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)
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700150 &quot;A String&quot;,
151 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800152 &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.
153 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
154}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700155</div>
156
157<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700158 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700159 <pre>Deletes a log bucket.Changes the bucket&#x27;s lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700160
161Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700162 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; For example:&quot;projects/my-project/locations/global/buckets/my-bucket&quot; (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700163 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 { # 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 -0800172}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173</div>
174
175<div class="method">
176 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700177 <pre>Gets a log bucket.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700178
179Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700180 name: string, Required. The resource name of the bucket: &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; For example:&quot;projects/my-project/locations/global/buckets/my-bucket&quot; (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700189 { # Describes a repository in which log entries are stored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800190 &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.
191 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
192 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700193 &quot;locked&quot;: True or False, # Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
194 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
195 &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)
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700196 &quot;A String&quot;,
197 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800198 &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.
199 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
200}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700201</div>
202
203<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800204 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700205 <pre>Lists log buckets.
Bu Sun Kim65020912020-05-20 12:08:20 -0700206
207Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 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)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700209 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 -0800210 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 -0700211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
215
216Returns:
217 An object of the form:
218
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700219 { # The response from ListBuckets.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800220 &quot;buckets&quot;: [ # A list of buckets.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700221 { # Describes a repository in which log entries are stored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800222 &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.
223 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
224 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700225 &quot;locked&quot;: True or False, # Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
226 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
227 &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)
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700228 &quot;A String&quot;,
229 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800230 &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.
231 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
232 },
233 ],
234 &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.
235}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700236</div>
237
238<div class="method">
239 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
240 <pre>Retrieves the next page of results.
241
242Args:
243 previous_request: The request for the previous page. (required)
244 previous_response: The response from the request for the previous page. (required)
245
246Returns:
247 A request object that you can call &#x27;execute()&#x27; on to request the next
248 page. Returns None if there are no more items in the collection.
249 </pre>
250</div>
251
252<div class="method">
253 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700254 <pre>Updates a log 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 lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket&#x27;s location cannot be changed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700255
256Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700257 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; For example:&quot;projects/my-project/locations/global/buckets/my-bucket&quot; (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700258 body: object, The request body.
259 The object takes the form of:
260
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700261{ # Describes a repository in which log entries are stored.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800262 &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 -0800263 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
264 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700265 &quot;locked&quot;: True or False, # Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
266 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
267 &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)
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700268 &quot;A String&quot;,
269 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800270 &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.
271 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Bu Sun Kim65020912020-05-20 12:08:20 -0700272}
273
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700274 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.FieldMaskFor example: updateMask=retention_days
Bu Sun Kim65020912020-05-20 12:08:20 -0700275 x__xgafv: string, V1 error format.
276 Allowed values
277 1 - v1 error format
278 2 - v2 error format
279
280Returns:
281 An object of the form:
282
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700283 { # Describes a repository in which log entries are stored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 &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.
285 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
286 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700287 &quot;locked&quot;: True or False, # Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
288 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
289 &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)
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700290 &quot;A String&quot;,
291 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800292 &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.
293 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
294}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700295</div>
296
297<div class="method">
298 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700299 <pre>Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700300
301Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700302 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; For example:&quot;projects/my-project/locations/global/buckets/my-bucket&quot; (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700303 body: object, The request body.
304 The object takes the form of:
305
306{ # The parameters to UndeleteBucket.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800307}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308
309 x__xgafv: string, V1 error format.
310 Allowed values
311 1 - v1 error format
312 2 - v2 error format
313
314Returns:
315 An object of the form:
316
317 { # 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 -0800318}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700319</div>
320
321</body></html>