Stackdriver Logging V2 Client - Class UpdateBucketRequest (1.25.5)

Version 1.25.5

• 1.31.2 (latest)
• 1.31.1
• 1.30.3
• 1.29.0
• 1.28.5
• 1.27.1
• 1.26.0
• 1.25.5
• 1.24.10

Reference documentation and code samples for the Stackdriver Logging V2 Client class UpdateBucketRequest.

The parameters to UpdateBucket.

Generated from protobuf message google.logging.v2.UpdateBucketRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example: "projects/my-project/locations/global/buckets/my-bucket"
↳ bucket	Google\Cloud\Logging\V2\LogBucket Required. The updated bucket.
↳ update_mask	Google\Protobuf\FieldMask Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated. For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: updateMask=retention_days

getName

Required. The full resource name of the bucket to update.

"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example: "projects/my-project/locations/global/buckets/my-bucket"

Returns
Type	Description
string

setName

Required. The full resource name of the bucket to update.

"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example: "projects/my-project/locations/global/buckets/my-bucket"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBucket

Required. The updated bucket.

Returns
Type	Description
Google\Cloud\Logging\V2\LogBucket|null

hasBucket

clearBucket

setBucket

Required. The updated bucket.

Parameter
Name	Description
var	Google\Cloud\Logging\V2\LogBucket

Returns
Type	Description
$this

getUpdateMask

Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask.

name and output only fields cannot be updated. For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: updateMask=retention_days

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask.

name and output only fields cannot be updated. For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: updateMask=retention_days

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this