Google Cloud Logging v2 API - Class Settings (4.3.0)

public sealed class Settings : IMessage<Settings>, IEquatable<Settings>, IDeepCloneable<Settings>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Logging v2 API class Settings.

Describes the settings associated with a project, folder, organization, billing account, or flexible resource.

Inheritance

object > Settings

Implements

IMessage Settings, IEquatable Settings, IDeepCloneable Settings, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

Settings()

public Settings()

Settings(Settings)

public Settings(Settings other)

Parameter
Name	Description
`other`	`Settings`

Properties

DisableDefaultSink

public bool DisableDefaultSink { get; set; }

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.

Property Value
Type	Description
`bool`

KmsKeyName

public string KmsKeyName { get; set; }

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.

Property Value
Type	Description
`string`

KmsServiceAccountId

public string KmsServiceAccountId { get; set; }

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 for more information.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

Output only. The resource name of the settings.

Property Value
Type	Description
`string`

SettingsName

public SettingsName SettingsName { get; set; }

SettingsName-typed view over the Name resource name property.

Property Value
Type	Description
`SettingsName`

StorageLocation

public string StorageLocation { get; set; }

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.

Property Value
Type	Description
`string`