public interface SettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
getDisableDefaultSink()
Optional.
|
String |
getKmsKeyName()
Optional.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
Optional.
|
String |
getKmsServiceAccountId()
Output only.
|
com.google.protobuf.ByteString |
getKmsServiceAccountIdBytes()
Output only.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
String |
getStorageLocation()
Optional.
|
com.google.protobuf.ByteString |
getStorageLocationBytes()
Optional.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getName()
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getNameBytes()
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];String getKmsKeyName()
Optional. The resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
For example:
`"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`
To enable CMEK for the Log Router, set this field to a valid
`kms_key_name` for which the associated service account has the required
`roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key.
The Cloud KMS key used by the Log Router can be updated by changing the
`kms_key_name` to a new valid key name. Encryption operations that are in
progress will be completed with the key that was in use when they started.
Decryption operations will be completed using the key that was used at the
time of encryption unless access to that key has been revoked.
To disable CMEK for the Log Router, set this field to an empty string.
See [Enabling CMEK for Log
Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];com.google.protobuf.ByteString getKmsKeyNameBytes()
Optional. The resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
For example:
`"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`
To enable CMEK for the Log Router, set this field to a valid
`kms_key_name` for which the associated service account has the required
`roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key.
The Cloud KMS key used by the Log Router can be updated by changing the
`kms_key_name` to a new valid key name. Encryption operations that are in
progress will be completed with the key that was in use when they started.
Decryption operations will be completed using the key that was used at the
time of encryption unless access to that key has been revoked.
To disable CMEK for the Log Router, set this field to an empty string.
See [Enabling CMEK for Log
Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];String getKmsServiceAccountId()
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getKmsServiceAccountIdBytes()
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];String getStorageLocation()
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];com.google.protobuf.ByteString getStorageLocationBytes()
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];boolean getDisableDefaultSink()
Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
bool disable_default_sink = 5 [(.google.api.field_behavior) = OPTIONAL];Copyright © 2023 Google LLC. All rights reserved.