public sealed class LogBucket : IMessage<LogBucket>, IEquatable<LogBucket>, IDeepCloneable<LogBucket>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Logging v2 API class LogBucket.
Describes a repository in which log entries are stored.
Implements
IMessageLogBucket, IEquatableLogBucket, IDeepCloneableLogBucket, IBufferMessage, IMessageNamespace
Google.Cloud.Logging.V2Assembly
Google.Cloud.Logging.V2.dll
Constructors
LogBucket()
public LogBucket()LogBucket(LogBucket)
public LogBucket(LogBucket other)| Parameter | |
|---|---|
| Name | Description |
other | LogBucket |
Properties
AnalyticsEnabled
public bool AnalyticsEnabled { get; set; }Whether log analytics is enabled for this bucket.
Once enabled, log analytics features cannot be disabled.
| Property Value | |
|---|---|
| Type | Description |
bool | |
CmekSettings
public CmekSettings CmekSettings { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
CmekSettings | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Description
public string Description { get; set; }Describes this bucket.
| Property Value | |
|---|---|
| Type | Description |
string | |
IndexConfigs
public RepeatedField<IndexConfig> IndexConfigs { get; }A list of indexed fields and related configuration data.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldIndexConfig | |
LifecycleState
public LifecycleState LifecycleState { get; set; }Output only. The bucket lifecycle state.
| Property Value | |
|---|---|
| Type | Description |
LifecycleState | |
Locked
public bool Locked { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
LogBucketName
public LogBucketName LogBucketName { get; set; }LogBucketName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
LogBucketName | |
Name
public string Name { get; set; }Output only. The resource name of the bucket.
For example:
projects/my-project/locations/global/buckets/my-bucket
For a list of supported locations, see Supported Regions
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.
| Property Value | |
|---|---|
| Type | Description |
string | |
RestrictedFields
public RepeatedField<string> RestrictedFields { get; }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)
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring | |
RetentionDays
public int RetentionDays { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The last update timestamp of the bucket.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |