Stackdriver Logging V2 Client - Class UpdateExclusionRequest (1.29.0)

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

The parameters to UpdateExclusion.

Generated from protobuf message google.logging.v2.UpdateExclusionRequest

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example: `"projects/my-project/exclusions/my-exclusion"`
`↳ exclusion`	`Google\Cloud\Logging\V2\LogExclusion` Required. New values for the existing exclusion. Only the fields specified in `update_mask` are relevant.
`↳ update_mask`	`Google\Protobuf\FieldMask` Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `"filter,description"`.

getName

Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example: "projects/my-project/exclusions/my-exclusion"

Returns
Type	Description
`string`

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExclusion

Required. New values for the existing exclusion. Only the fields specified in update_mask are relevant.

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

hasExclusion

clearExclusion

setExclusion

Required. New values for the existing exclusion. Only the fields specified in update_mask are relevant.

Parameter
Name	Description
`var`	`Google\Cloud\Logging\V2\LogExclusion`

Returns
Type	Description
`$this`

getUpdateMask

Required. A non-empty list of fields to change in the existing exclusion.

New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description".

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. A non-empty list of fields to change in the existing exclusion.

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

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`name`	`string` Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example: `"projects/my-project/exclusions/my-exclusion"` Please see Google\Cloud\Logging\V2\ConfigServiceV2Client::logExclusionName() for help formatting this field.
`exclusion`	`Google\Cloud\Logging\V2\LogExclusion` Required. New values for the existing exclusion. Only the fields specified in `update_mask` are relevant.
`updateMask`	`Google\Protobuf\FieldMask` Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `"filter,description"`.

Returns
Type	Description
`Google\Cloud\Logging\V2\UpdateExclusionRequest`