Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / fc8cf4d97cbb870dad5137e34fd6ce973b4af5be / . / docs / dyn / logging_v2.billingAccounts.buckets.html
blob: 2a04fa476e4a432da91b56e193a12a8d4042dea8 [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.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.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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]87<p class="firstline">Gets a bucket.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]88<h3>Method Details</h3>
89<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90 <code class="details" id="close">close()</code>
91 <pre>Close httplib2 connections.</pre>
92</div>
93
94<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]96 <pre>Gets a bucket.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97
98Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 x__xgafv: string, V1 error format.
101 Allowed values
102 1 - v1 error format
103 2 - v2 error format
104
105Returns:
106 An object of the form:
107
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]108 { # Describes a repository of logs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 &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.
110 &quot;description&quot;: &quot;A String&quot;, # Describes this bucket.
111 &quot;lifecycleState&quot;: &quot;A String&quot;, # Output only. The bucket lifecycle state.
112 &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]113 &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]114 &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.
115 &quot;A String&quot;,
116 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]117 &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.
118 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the bucket.
119}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120</div>
121
122</body></html>