Reference documentation and code samples for the Stackdriver Logging V2 Client class Settings.
Describes the settings associated with a project, folder, organization, billing account, or flexible resource.
Generated from protobuf message google.logging.v2.Settings
Namespace
Google \ Cloud \ Logging \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the settings.
↳ kms_key_name
string
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
for more information.
↳ kms_service_account_id
string
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
to obtain the service account ID. See Enabling CMEK for Log Router
for more information.
↳ storage_location
string
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.
↳ disable_default_sink
bool
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.
getName
Output only. The resource name of the settings.
string
setName
Output only. The resource name of the settings.
var
string
$this
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
for more information.
string
setKmsKeyName
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
for more information.
var
string
$this
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
to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string
setKmsServiceAccountId
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
to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
var
string
$this
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
setStorageLocation
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.
var
string
$this
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
setDisableDefaultSink
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.
var
bool
$this
