Observability API . projects . locations . buckets

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get bucket resource.

Args:
  name: string, Required. Name of the bucket to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Bucket configuration for storing observability data.
  "cmekSettings": { # Settings for configuring CMEK for a bucket. # Optional. Settings for configuring CMEK on a bucket.
    "kmsKey": "A 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": "A 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 `kms_key` that has been configured. It is populated when the CMEK settings are bound to a single key version.
    "serviceAccountId": "A String", # Output only. The service account used to access the key.
  },
  "createTime": "A String", # Output only. Create timestamp.
  "deleteTime": "A String", # Output only. Delete timestamp.
  "description": "A String", # Optional. Description of the bucket.
  "displayName": "A String", # Optional. User friendly display name.
  "name": "A String", # Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
  "purgeTime": "A String", # Output only. Timestamp when the bucket in soft-deleted state is purged.
  "updateTime": "A String", # Output only. Update timestamp.
}

list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

List buckets of a project in a particular location.

Args:
  parent: string, Required. The parent, which owns this collection of buckets. The format is: projects/[PROJECT_ID]/locations/[LOCATION] (required)
  pageSize: integer, Optional. The maximum number of buckets to return. If unspecified, then at most 100 buckets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListBuckets` call. Provide this to retrieve the subsequent page.
  showDeleted: boolean, Optional. If true, then the response will include deleted buckets.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for listing buckets.
  "buckets": [ # Optional. The list of buckets.
    { # Bucket configuration for storing observability data.
      "cmekSettings": { # Settings for configuring CMEK for a bucket. # Optional. Settings for configuring CMEK on a bucket.
        "kmsKey": "A 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": "A 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 `kms_key` that has been configured. It is populated when the CMEK settings are bound to a single key version.
        "serviceAccountId": "A String", # Output only. The service account used to access the key.
      },
      "createTime": "A String", # Output only. Create timestamp.
      "deleteTime": "A String", # Output only. Delete timestamp.
      "description": "A String", # Optional. Description of the bucket.
      "displayName": "A String", # Optional. User friendly display name.
      "name": "A String", # Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
      "purgeTime": "A String", # Output only. Timestamp when the bucket in soft-deleted state is purged.
      "updateTime": "A String", # Output only. Update timestamp.
    },
  ],
  "nextPageToken": "A String", # Optional. A token that can be sent as `page_token` to retrieve the next page. When this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.