REST Resource: organizations.locations.buckets Stay organized with collections Save and categorize content based on your preferences.
Resource: LogBucket
Describes a repository in which log entries are stored.
| JSON representation |
|---|
{"name":string,"description":string,"createTime":string,"updateTime":string,"retentionDays":integer,"locked":boolean,"lifecycleState":enum ( |
| Fields | |
|---|---|
name |
Output only. The resource name of the bucket. For example:
For a list of supported locations, seeSupported Regions For the location of After a bucket has been created, the location cannot be changed. |
description |
Optional. Describes this bucket. |
createTime |
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. The last update timestamp of the bucket. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
retentionDays |
Optional. 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. |
locked |
Optional. 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. |
lifecycleState |
Output only. The bucket lifecycle state. |
analyticsEnabled |
Optional. Whether log analytics is enabled for this bucket. Once enabled, log analytics features cannot be disabled. |
restrictedFields[] |
Optional. Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. |
indexConfigs[] |
Optional. A list of indexed fields and related configuration data. |
cmekSettings |
Optional. The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. |
Methods | |
|---|---|
| Creates a log bucket that can be used to store log entries. |
| Creates a log bucket asynchronously that can be used to store log entries. |
| Deletes a log bucket. |
| Gets a log bucket. |
| Lists log buckets. |
| Updates a log bucket. |
| Undeletes a log bucket. |
| Updates a log bucket asynchronously. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-27 UTC.