Stackdriver Logging V2 Client - Class UpdateBucketRequest (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"

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setName

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBucket

Required. The updated bucket.

Generated from protobuf field .google.logging.v2.LogBucket bucket = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasBucket

clearBucket

setBucket

Required. The updated bucket.

Generated from protobuf field .google.logging.v2.LogBucket bucket = 2 [(.google.api.field_behavior) = REQUIRED];

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

Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

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.

Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`