buckets

Creates, updates, deletes, gets or lists a buckets resource.

Overview

Name	buckets
Type	Resource
Id	google.observability.buckets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
cmekSettings	object	Optional. Settings for configuring CMEK on a bucket. (id: CmekSettings)
createTime	string (google-datetime)	Output only. Create timestamp.
deleteTime	string (google-datetime)	Output only. Delete timestamp.
description	string	Optional. Description of the bucket.
displayName	string	Optional. User friendly display name.
purgeTime	string (google-datetime)	Output only. Timestamp when the bucket in soft-deleted state is purged.
updateTime	string (google-datetime)	Output only. Update timestamp.

list

Name	Datatype	Description
name	string	Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
cmekSettings	object	Optional. Settings for configuring CMEK on a bucket. (id: CmekSettings)
createTime	string (google-datetime)	Output only. Create timestamp.
deleteTime	string (google-datetime)	Output only. Delete timestamp.
description	string	Optional. Description of the bucket.
displayName	string	Optional. User friendly display name.
purgeTime	string (google-datetime)	Output only. Timestamp when the bucket in soft-deleted state is purged.
updateTime	string (google-datetime)	Output only. Update timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, bucketsId		Get bucket resource.
list	select	projectsId, locationsId	showDeleted, pageSize, pageToken	List buckets of a project in a particular location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bucketsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean

SELECT examples

get

Get bucket resource.

SELECT
name,
cmekSettings,
createTime,
deleteTime,
description,
displayName,
purgeTime,
updateTime
FROM google.observability.buckets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
;

list

List buckets of a project in a particular location.

SELECT
name,
cmekSettings,
createTime,
deleteTime,
description,
displayName,
purgeTime,
updateTime
FROM google.observability.buckets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND showDeleted = '{{ showDeleted }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;