Google Cloud Observability V1 Client - Class Bucket (0.1.0)

Reference documentation and code samples for the Google Cloud Observability V1 Client class Bucket.

Bucket configuration for storing observability data.

Generated from protobuf message google.cloud.observability.v1.Bucket

Namespace

Google \ Cloud \ Observability \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

↳ display_name string

Optional. User friendly display name.

↳ description string

Optional. Description of the bucket.

↳ create_time Google\Protobuf\Timestamp

Output only. Create timestamp.

↳ update_time Google\Protobuf\Timestamp

Output only. Update timestamp.

↳ delete_time Google\Protobuf\Timestamp

Output only. Delete timestamp.

↳ purge_time Google\Protobuf\Timestamp

Output only. Timestamp when the bucket in soft-deleted state is purged.

↳ cmek_settings CmekSettings

Optional. Settings for configuring CMEK on a bucket.

getName

Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

Returns
Type Description
string

setName

Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. User friendly display name.

Returns
Type Description
string

setDisplayName

Optional. User friendly display name.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Description of the bucket.

Returns
Type Description
string

setDescription

Optional. Description of the bucket.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Create timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Update timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeleteTime

Output only. Delete timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. Delete timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPurgeTime

Output only. Timestamp when the bucket in soft-deleted state is purged.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasPurgeTime

clearPurgeTime

setPurgeTime

Output only. Timestamp when the bucket in soft-deleted state is purged.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCmekSettings

Optional. Settings for configuring CMEK on a bucket.

Returns
Type Description
CmekSettings|null

hasCmekSettings

clearCmekSettings

setCmekSettings

Optional. Settings for configuring CMEK on a bucket.

Parameter
Name Description
var CmekSettings
Returns
Type Description
$this