Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::BackendServiceLogConfig (v2.1.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::BackendServiceLogConfig.

The available logging options for the load balancer traffic served by this backend service.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#enable

def enable() -> ::Boolean
Returns
  • (::Boolean) — Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.

#enable=

def enable=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
Returns
  • (::Boolean) — Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.

#optional_fields

def optional_fields() -> ::Array<::String>
Returns
  • (::Array<::String>) — This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace

#optional_fields=

def optional_fields=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
Returns
  • (::Array<::String>) — This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace

#optional_mode

def optional_mode() -> ::String
Returns
  • (::String) — This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL. Check the OptionalMode enum for the list of possible values.

#optional_mode=

def optional_mode=(value) -> ::String
Parameter
  • value (::String) — This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL. Check the OptionalMode enum for the list of possible values.
Returns
  • (::String) — This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL. Check the OptionalMode enum for the list of possible values.

#sample_rate

def sample_rate() -> ::Float
Returns
  • (::Float) — This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

#sample_rate=

def sample_rate=(value) -> ::Float
Parameter
  • value (::Float) — This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
Returns
  • (::Float) — This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.