Struct LogBucket

pub struct LogBucket {
    pub name: String,
    pub description: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub retention_days: i32,
    pub locked: bool,
    pub lifecycle_state: i32,
    pub analytics_enabled: bool,
    pub restricted_fields: Vec<String>,
    pub index_configs: Vec<IndexConfig>,
    pub cmek_settings: Option<CmekSettings>,
}

Describes a repository in which log entries are stored.

Fields

name: String

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.

description: String

Describes this bucket.

create_time: Option<Timestamp>

Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.

update_time: Option<Timestamp>

Output only. The last update timestamp of the bucket.

retention_days: i32

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: 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.

lifecycle_state: i32

Output only. The bucket lifecycle state.

analytics_enabled: bool

Whether log analytics is enabled for this bucket.

Once enabled, log analytics features cannot be disabled.

restricted_fields: Vec<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)

index_configs: Vec<IndexConfig>

A list of indexed fields and related configuration data.

cmek_settings: Option<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.

Implementations

impl LogBucket

pub fn lifecycle_state(&self) -> LifecycleState

Returns the enum value of lifecycle_state, or the default if the field is set to an invalid enum value.

pub fn set_lifecycle_state(&mut self, value: LifecycleState)

Sets lifecycle_state to the provided enum value.

Trait Implementations

impl Clone for LogBucket

fn clone(&self) -> LogBucket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LogBucket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LogBucket

fn default() -> Self

Returns the “default value” for a type.

impl Message for LogBucket

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for LogBucket

fn eq(&self, other: &LogBucket) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LogBucket