Cloud Logging V2 API - Class Google::Cloud::Logging::V2::Settings (v0.13.0)

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#disable_default_sink

def disable_default_sink() -> ::Boolean
Returns
  • (::Boolean) — 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.

#disable_default_sink=

def disable_default_sink=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#kms_key_name

def kms_key_name() -> ::String
Returns
  • (::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_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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

def kms_service_account_id() -> ::String
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the settings.

#storage_location

def storage_location() -> ::String
Returns
  • (::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.

#storage_location=

def storage_location=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.