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.



6858
6859
6860
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6858

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) 


6810
6811
6812
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6810

def enable
  @enable
end

#logging_http_request_headers ⇒ Array<Google::Apis::ComputeAlpha::BackendServiceLogConfigLoggingHttpHeader>

The list of request headers that will be logged to Stackdriver. Corresponds to the JSON property loggingHttpRequestHeaders

Returns:



6816
6817
6818
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6816

def logging_http_request_headers
  @logging_http_request_headers
end

#logging_http_response_headers ⇒ Array<Google::Apis::ComputeAlpha::BackendServiceLogConfigLoggingHttpHeader>

The list of response headers that will be logged to Stackdriver. Corresponds to the JSON property loggingHttpResponseHeaders

Returns:



6821
6822
6823
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6821

def logging_http_response_headers
  @logging_http_response_headers
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) 


6830
6831
6832
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6830

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>) 


6839
6840
6841
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6839

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) 


6847
6848
6849
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6847

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) 


6856
6857
6858
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6856

def sample_rate
  @sample_rate
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6863
6864
6865
6866
6867
6868
6869
6870
6871
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6863

def update!(**args)
  @enable = args[:enable] if args.key?(:enable)
  @logging_http_request_headers = args[:logging_http_request_headers] if args.key?(:logging_http_request_headers)
  @logging_http_response_headers = args[:logging_http_response_headers] if args.key?(:logging_http_response_headers)
  @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