Reference documentation and code samples for the Stackdriver Logging V2 Client class UpdateCmekSettingsRequest.
The parameters to UpdateCmekSettings.
See Enabling CMEK for Log Router for more information.
Generated from protobuf message google.logging.v2.UpdateCmekSettingsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example: |
↳ cmek_settings |
Google\Cloud\Logging\V2\CmekSettings
Required. The CMEK settings to update. See Enabling CMEK for Log Router for more information. |
↳ update_mask |
Google\Protobuf\FieldMask
Optional. Field mask identifying which fields from |
getName
Required. The resource name for the CMEK settings to update.
"projects/[PROJECT_ID]/cmekSettings"
"organizations/[ORGANIZATION_ID]/cmekSettings"
"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
"folders/[FOLDER_ID]/cmekSettings"
For example:
"organizations/12345/cmekSettings"
Note: CMEK 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The resource name for the CMEK settings to update.
"projects/[PROJECT_ID]/cmekSettings"
"organizations/[ORGANIZATION_ID]/cmekSettings"
"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
"folders/[FOLDER_ID]/cmekSettings"
For example:
"organizations/12345/cmekSettings"
Note: CMEK 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCmekSettings
Required. The CMEK settings to update.
See Enabling CMEK for Log Router for more information.
Generated from protobuf field .google.logging.v2.CmekSettings cmek_settings = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Logging\V2\CmekSettings|null | |
hasCmekSettings
clearCmekSettings
setCmekSettings
Required. The CMEK settings to update.
See Enabling CMEK for Log Router for more information.
Generated from protobuf field .google.logging.v2.CmekSettings cmek_settings = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Logging\V2\CmekSettings
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
Optional. Field mask identifying which fields from cmek_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"
Generated from protobuf field .google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. Field mask identifying which fields from cmek_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"
Generated from protobuf field .google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |