GetFolderBucketResult class

Result data returned by getFolderBucket.

Constructors

GetFolderBucketResult({required bool analyticsEnabled, required CmekSettingsResponse cmekSettings, required String createTime, required String description, required List<IndexConfigResponse> indexConfigs, required String lifecycleState, required bool locked, required String name, required List<String> restrictedFields, required int retentionDays, required String updateTime})
Creates a new GetFolderBucketResult. analyticsEnabled Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. cmekSettings 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. createTime The creation timestamp of the bucket. This is not set for any of the default buckets. description Describes this bucket. indexConfigs A list of indexed fields and related configuration data. lifecycleState The bucket lifecycle state. locked 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. name The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)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. restrictedFields 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) retentionDays 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. updateTime The last update timestamp of the bucket.
const
GetFolderBucketResult.fromMap(Map<String, dynamic> map)
factory

Properties

analyticsEnabled → bool
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
final
cmekSettings → CmekSettingsResponse
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.
final
createTime → String
The creation timestamp of the bucket. This is not set for any of the default buckets.
final
description → String
Describes this bucket.
final
hashCode → int
The hash code for this object.
no setterinherited
indexConfigs → List<IndexConfigResponse>
A list of indexed fields and related configuration data.
final
lifecycleState → String
The bucket lifecycle state.
final
locked → bool
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.
final
name → String
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)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.
final
restrictedFields → List<String>
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)
final
retentionDays → int
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
updateTime → String
The last update timestamp of the bucket.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited