REST Resource: projects.locations.buckets

Resource: Bucket

Bucket configuration for storing observability data.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "purgeTime": string,
  "cmekSettings": {
    object (CmekSettings)
  }
}
Fields
name

string

Identifier. Name of the bucket. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
displayName

string

Optional. User friendly display name.

description

string

Optional. Description of the bucket.

createTime

string (Timestamp format)

Output only. Create timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Update timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

deleteTime

string (Timestamp format)

Output only. Delete timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

purgeTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

cmekSettings

object (CmekSettings)

Optional. Settings for configuring CMEK on a bucket.

CmekSettings

Settings for configuring CMEK for a bucket.

JSON representation
{
  "kmsKey": string,
  "kmsKeyVersion": string,
  "serviceAccountId": string
}
Fields
kmsKey

string

Optional. The resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
kmsKeyVersion

string

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

This read-only field is used to convey the specific configured CryptoKeyVersion of the kmsKey that has been configured. It is populated when the CMEK settings are bound to a single key version.

serviceAccountId

string

Output only. The service account used to access the key.

Methods

get

Get bucket resource.

list

List buckets of a project in a particular location.