Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / logging_v2.billingAccounts.locations.buckets.html
blob: 0bace062f5af5f04097d54b94db96a161480f0bd [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.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 -0700[diff] [blame]78 <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 -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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]92 <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]93<p class="firstline">Lists buckets.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94<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 -0700[diff] [blame]99<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]100<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 -0700[diff] [blame]103<h3>Method Details</h3>
104<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105 <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 -0700[diff] [blame]118{ # Describes a repository of logs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]119 &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 The supported locations are: &quot;global&quot;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 Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]120 &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 Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]121 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]122 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
123 &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.
124 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
125 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126}
127
128 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.
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134Returns:
135 An object of the form:
136
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 { # Describes a repository of logs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]138 &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 The supported locations are: &quot;global&quot;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 Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]139 &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 Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]140 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]141 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
142 &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.
143 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
150 <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.
151
152Args:
153 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)
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
162 { # 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 {}.
163 }</pre>
164</div>
165
166<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]167 <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]168 <pre>Lists buckets.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169
170Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171 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]172 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^]173 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]174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179Returns:
180 An object of the form:
181
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]182 { # The response from ListBuckets.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]183 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;buckets&quot;: [ # A list of buckets.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]185 { # Describes a repository of logs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]186 &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 The supported locations are: &quot;global&quot;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 Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]187 &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 Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]188 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]189 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
190 &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.
191 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
192 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 },
194 ],
195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
200 <pre>Retrieves the next page of results.
201
202Args:
203 previous_request: The request for the previous page. (required)
204 previous_response: The response from the request for the previous page. (required)
205
206Returns:
207 A request object that you can call &#x27;execute()&#x27; on to request the next
208 page. Returns None if there are no more items in the collection.
209 </pre>
210</div>
211
212<div class="method">
213 <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]214 <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]215
216Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 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]218 body: object, The request body.
219 The object takes the form of:
220
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]221{ # Describes a repository of logs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]222 &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 The supported locations are: &quot;global&quot;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 Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]223 &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 Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]224 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]225 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
226 &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.
227 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
228 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229}
230
231 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.
232 x__xgafv: string, V1 error format.
233 Allowed values
234 1 - v1 error format
235 2 - v2 error format
236
237Returns:
238 An object of the form:
239
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]240 { # Describes a repository of logs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]241 &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 The supported locations are: &quot;global&quot;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 Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]242 &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 Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]243 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]244 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
245 &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.
246 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
247 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]248 }</pre>
249</div>
250
251<div class="method">
252 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
253 <pre>Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.
254
255Args:
256 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)
257 body: object, The request body.
258 The object takes the form of:
259
260{ # The parameters to UndeleteBucket.
261 }
262
263 x__xgafv: string, V1 error format.
264 Allowed values
265 1 - v1 error format
266 2 - v2 error format
267
268Returns:
269 An object of the form:
270
271 { # 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 {}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]272 }</pre>
273</div>
274
275</body></html>