Show / Hide Table of Contents

Class Settings

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

Inheritance
object
Settings
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Logging.v2.Data
Assembly: Google.Apis.Logging.v2.dll
Syntax
public class Settings : IDirectResponseSchema

Properties

DefaultSinkConfig

Optional. Overrides the built-in configuration for _Default sink.

Declaration
[JsonProperty("defaultSinkConfig")]
public virtual DefaultSinkConfig DefaultSinkConfig { get; set; }
Property Value
Type Description
DefaultSinkConfig

DisableDefaultSink

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 storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.

Declaration
[JsonProperty("disableDefaultSink")]
public virtual bool? DisableDefaultSink { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

KmsKeyName

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, 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.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.

Declaration
[JsonProperty("kmsKeyName")]
public virtual string KmsKeyName { get; set; }
Property Value
Type Description
string

KmsServiceAccountId

Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that will be used to access your Cloud KMS key. Use 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.

Declaration
[JsonProperty("kmsServiceAccountId")]
public virtual string KmsServiceAccountId { get; set; }
Property Value
Type Description
string

LoggingServiceAccountId

Output only. The service account for the given resource container, such as project or folder. Log sinks use this service account as their writer_identity if no custom service account is provided in the request when calling the create sink method.

Declaration
[JsonProperty("loggingServiceAccountId")]
public virtual string LoggingServiceAccountId { get; set; }
Property Value
Type Description
string

Name

Output only. The resource name of the settings.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

StorageLocation

Optional. The storage location for the _Default and _Required log buckets of newly created projects and folders, unless the storage location is explicitly provided.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets.

Declaration
[JsonProperty("storageLocation")]
public virtual string StorageLocation { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX