Reference documentation and code samples for the Compute V1 Client class BackendServiceLogConfig.
The available logging options for the load balancer traffic served by this backend service.
Generated from protobuf message google.cloud.compute.v1.BackendServiceLogConfig
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ enable
bool
Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
↳ optional_fields
array
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
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
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.
getEnable
Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
bool
hasEnable
clearEnable
setEnable
Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
var
bool
$this
getOptionalFields
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
setOptionalFields
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
var
string[]
$this
getOptionalMode
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.
string
hasOptionalMode
clearOptionalMode
setOptionalMode
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.
var
string
$this
getSampleRate
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.
float
hasSampleRate
clearSampleRate
setSampleRate
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.
var
float
$this
