Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f0c2fa653712b63bb121d6b59a0de8c7103480e4 / . / docs / dyn / logging_v2.projects.locations.buckets.html
blob: 1bc9c1054c1d449ec5702abf081525ee58ddcf3b [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.projects.html">projects</a> . <a href="logging_v2.projects.locations.html">locations</a> . <a href="logging_v2.projects.locations.buckets.html">buckets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]78 <code><a href="logging_v2.projects.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 -0700[diff] [blame]83 <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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]93<p class="firstline">Gets a bucket.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]96<p class="firstline">Lists buckets.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97<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>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]102<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 -0700[diff] [blame]103<p class="toc_element">
104 <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
105<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 -0700[diff] [blame]106<h3>Method Details</h3>
107<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 <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>
114 <pre>Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115
116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 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)
118 body: object, The request body.
119 The object takes the form of:
120
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121{ # Describes a repository of logs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]122 &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 -0800[diff] [blame]123 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
124 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
125 &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 -0800[diff] [blame]126 &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 -0700[diff] [blame^]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.
128 &quot;A String&quot;,
129 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]130 &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 -0700[diff] [blame]132}
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 -0700[diff] [blame]135 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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]143 { # Describes a repository of logs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]144 &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.
147 &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 -0800[diff] [blame]148 &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 -0700[diff] [blame^]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.
150 &quot;A String&quot;,
151 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]152 &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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155</div>
156
157<div class="method">
158 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
159 <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.
160
161Args:
162 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)
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 { # 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 -0800[diff] [blame]172}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]173</div>
174
175<div class="method">
176 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]177 <pre>Gets a bucket.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178
179Args:
180 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; Example: &quot;projects/my-project-id/locations/my-location/buckets/my-bucket-id&quot;. (required)
181 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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]189 { # Describes a repository of logs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]190 &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.
193 &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 -0800[diff] [blame]194 &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 -0700[diff] [blame^]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.
196 &quot;A String&quot;,
197 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]198 &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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201</div>
202
203<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]204 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]205 <pre>Lists buckets.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206
207Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]208 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 -0800[diff] [blame]209 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 -0800[diff] [blame]210 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 -0700[diff] [blame]211 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 -0700[diff] [blame]219 { # The response from ListBuckets.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]220 &quot;buckets&quot;: [ # A list of buckets.
221 { # Describes a repository of logs.
222 &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.
225 &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 -0800[diff] [blame]226 &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 -0700[diff] [blame^]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.
228 &quot;A String&quot;,
229 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]230 &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 -0700[diff] [blame]236</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>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]254 <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 -0700[diff] [blame]255
256Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]257 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 -0700[diff] [blame]258 body: object, The request body.
259 The object takes the form of:
260
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]261{ # Describes a repository of logs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]262 &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 -0800[diff] [blame]263 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
264 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
265 &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 -0800[diff] [blame]266 &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 -0700[diff] [blame^]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.
268 &quot;A String&quot;,
269 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]270 &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 -0700[diff] [blame]272}
273
274 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.
275 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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]283 { # Describes a repository of logs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]284 &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.
287 &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 -0800[diff] [blame]288 &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 -0700[diff] [blame^]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.
290 &quot;A String&quot;,
291 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]292 &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 -0700[diff] [blame]295</div>
296
297<div class="method">
298 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
299 <pre>Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.
300
301Args:
302 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)
303 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 -0800[diff] [blame]307}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]308
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 -0800[diff] [blame]318}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]319</div>
320
321</body></html>