Class: Google::Apis::LoggingV2::Settings

Inherits:

Object

• Object
• Google::Apis::LoggingV2::Settings

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/logging_v2/classes.rb,
lib/google/apis/logging_v2/representations.rb,
lib/google/apis/logging_v2/representations.rb

Overview

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

Instance Attribute Summary

• #disable_default_sink ⇒ Boolean (also: #disable_default_sink?)

  Optional.

• #kms_key_name ⇒ String

  Optional.

• #kms_service_account_id ⇒ String

  Output only.

• #name ⇒ String

  Output only.

• #storage_location ⇒ String

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ Settings constructor

  A new instance of Settings.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Settings

Returns a new instance of Settings.

# File 'lib/google/apis/logging_v2/classes.rb', line 2447

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_default_sink ⇒ Boolean Also known as: disable_default_sink?

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. Corresponds to the JSON property disableDefaultSink

Returns:

• (Boolean)

# File 'lib/google/apis/logging_v2/classes.rb', line 2404

def disable_default_sink
  @disable_default_sink
end

#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 (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. Corresponds to the JSON property kmsKeyName

Returns:

• (String)

# File 'lib/google/apis/logging_v2/classes.rb', line 2423

def kms_key_name
  @kms_key_name
end

#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 (https://cloud. google.com/logging/docs/routing/managed-encryption) for more information. Corresponds to the JSON property kmsServiceAccountId

Returns:

• (String)

# File 'lib/google/apis/logging_v2/classes.rb', line 2433

def kms_service_account_id
  @kms_service_account_id
end

#name ⇒ String

Output only. The resource name of the settings. Corresponds to the JSON property name

Returns:

• (String)

# File 'lib/google/apis/logging_v2/classes.rb', line 2438

def name
  @name
end

#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. Corresponds to the JSON property storageLocation

Returns:

• (String)

# File 'lib/google/apis/logging_v2/classes.rb', line 2445

def storage_location
  @storage_location
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/logging_v2/classes.rb', line 2452

def update!(**args)
  @disable_default_sink = args[:disable_default_sink] if args.key?(:disable_default_sink)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @kms_service_account_id = args[:kms_service_account_id] if args.key?(:kms_service_account_id)
  @name = args[:name] if args.key?(:name)
  @storage_location = args[:storage_location] if args.key?(:storage_location)
end