Stackdriver Logging V2 Client - Class UpdateSettingsRequest (1.29.0)

Version latest

• 1.29.0 (latest)
• 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 UpdateSettingsRequest.

The parameters to UpdateSettings.

See Enabling CMEK for Log Router for more information.

Generated from protobuf message google.logging.v2.UpdateSettingsRequest

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 for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example: "organizations/12345/settings" Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.
↳ settings	Google\Cloud\Logging\V2\Settings Required. The settings to update. See Enabling CMEK for Log Router for more information.
↳ update_mask	Google\Protobuf\FieldMask Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated. See FieldMask for more information. For example: "updateMask=kmsKeyName"

getName

Required. The resource name for the settings to update.

"organizations/[ORGANIZATION_ID]/settings" For example: "organizations/12345/settings" Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

Returns
Type	Description
string

setName

Required. The resource name for the settings to update.

"organizations/[ORGANIZATION_ID]/settings" For example: "organizations/12345/settings" Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSettings

Required. The settings to update.

See Enabling CMEK for Log Router for more information.

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

hasSettings

clearSettings

setSettings

Required. The settings to update.

See Enabling CMEK for Log Router for more information.

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

Returns
Type	Description
$this

getUpdateMask

Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information. For example: "updateMask=kmsKeyName"

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information. For example: "updateMask=kmsKeyName"

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

static::build

Parameters
Name	Description
settings	Google\Cloud\Logging\V2\Settings Required. The settings to update. See Enabling CMEK for Log Router for more information.
updateMask	Google\Protobuf\FieldMask Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated. See FieldMask for more information. For example: "updateMask=kmsKeyName"

Returns
Type	Description
Google\Cloud\Logging\V2\UpdateSettingsRequest