Class: Google::Apis::ComputeAlpha::BackendServiceLogConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackendServiceLogConfig

Returns a new instance of BackendServiceLogConfig.



4924
4925
4926
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4924

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

Instance Attribute Details

#enable ⇒ Boolean Also known as: enable?

Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false. Corresponds to the JSON property enable

Returns:

  • (Boolean) 


4887
4888
4889
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4887

def enable
  @enable
end

#optional ⇒ String

Deprecated in favor of optionalMode. 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. Corresponds to the JSON property optional

Returns:

  • (String) 


4897
4898
4899
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4897

def optional
  @optional
end

#optional_fields ⇒ 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 Corresponds to the JSON property optionalFields

Returns:

  • (Array<String>) 


4905
4906
4907
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4905

def optional_fields
  @optional_fields
end

#optional_mode ⇒ 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. Corresponds to the JSON property optionalMode

Returns:

  • (String) 


4913
4914
4915
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4913

def optional_mode
  @optional_mode
end

#sample_rate ⇒ 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. Corresponds to the JSON property sampleRate

Returns:

  • (Float) 


4922
4923
4924
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4922

def sample_rate
  @sample_rate
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4929
4930
4931
4932
4933
4934
4935
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 4929

def update!(**args)
  @enable = args[:enable] if args.key?(:enable)
  @optional = args[:optional] if args.key?(:optional)
  @optional_fields = args[:optional_fields] if args.key?(:optional_fields)
  @optional_mode = args[:optional_mode] if args.key?(:optional_mode)
  @sample_rate = args[:sample_rate] if args.key?(:sample_rate)
end