Class: Google::Cloud::Logging::V2::LogBucket
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::V2::LogBucket
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/logging/v2/logging_config.rb
Overview
Describes a repository in which log entries are stored.
Instance Attribute Summary collapse
-
#cmek_settings ⇒ ::Google::Cloud::Logging::V2::CmekSettings
The CMEK settings of the log bucket.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#description ⇒ ::String
Describes this bucket.
-
#lifecycle_state ⇒ ::Google::Cloud::Logging::V2::LifecycleState
readonly
Output only.
-
#locked ⇒ ::Boolean
Whether the bucket is locked.
-
#name ⇒ ::String
readonly
Output only.
-
#restricted_fields ⇒ ::Array<::String>
Log entry field paths that are denied access in this bucket.
-
#retention_days ⇒ ::Integer
Logs will be retained by default for this amount of time, after which they will automatically be deleted.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
Instance Attribute Details
#cmek_settings ⇒ ::Google::Cloud::Logging::V2::CmekSettings
Returns 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.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#description ⇒ ::String
Returns Describes this bucket.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#lifecycle_state ⇒ ::Google::Cloud::Logging::V2::LifecycleState (readonly)
Returns Output only. The bucket lifecycle state.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#locked ⇒ ::Boolean
Returns 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.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#name ⇒ ::String (readonly)
Returns 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.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#restricted_fields ⇒ ::Array<::String>
Returns 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
).
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#retention_days ⇒ ::Integer
Returns 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.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The last update timestamp of the bucket.
81 82 83 84 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 81 class LogBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |