Reference documentation and code samples for the Stackdriver Logging V2 Client class LogBucket.
Describes a repository in which log entries are stored.
Generated from protobuf message google.logging.v2.LogBucket
Namespace
Google \ Cloud \ Logging \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
Google\Protobuf\Timestamp
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
↳ update_time
↳ retention_days
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.
↳ 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
int
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
array
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
↳ cmek_settings
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.
getName
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.
string
setName
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.
var
string
$this
getDescription
Describes this bucket.
string
setDescription
Describes this bucket.
var
string
$this
getCreateTime
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
$this
getUpdateTime
Output only. The last update timestamp of the bucket.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last update timestamp of the bucket.
$this
getRetentionDays
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.
int
setRetentionDays
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.
var
int
$this
getLocked
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.
bool
setLocked
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.
var
bool
$this
getLifecycleState
Output only. The bucket lifecycle state.
int
setLifecycleState
Output only. The bucket lifecycle state.
var
int
$this
getAnalyticsEnabled
Whether log analytics is enabled for this bucket.
Once enabled, log analytics features cannot be disabled.
bool
setAnalyticsEnabled
Whether log analytics is enabled for this bucket.
Once enabled, log analytics features cannot be disabled.
var
bool
$this
getRestrictedFields
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
)
setRestrictedFields
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
)
var
string[]
$this
getIndexConfigs
A list of indexed fields and related configuration data.
setIndexConfigs
A list of indexed fields and related configuration data.
$this
getCmekSettings
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.
hasCmekSettings
clearCmekSettings
setCmekSettings
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.
$this
