com.google.api.services.compute.model

Class BackendServiceLogConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.BackendServiceLogConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BackendServiceLogConfig
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BackendServiceLogConfig()

Method Summary

Modifier and Type	Method and Description
BackendServiceLogConfig	clone()
Boolean	getEnable() Denotes whether to enable logging for the load balancer traffic served by this backend service.
List<String>	getOptionalFields() This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM.
String	getOptionalMode() This field can only be specified if logging is enabled for this backend service.
Float	getSampleRate() This field can only be specified if logging is enabled for this backend service.
BackendServiceLogConfig	set(String fieldName, Object value)
BackendServiceLogConfig	setEnable(Boolean enable) Denotes whether to enable logging for the load balancer traffic served by this backend service.
BackendServiceLogConfig	setOptionalFields(List<String> optionalFields) This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM.
BackendServiceLogConfig	setOptionalMode(String optionalMode) This field can only be specified if logging is enabled for this backend service.
BackendServiceLogConfig	setSampleRate(Float sampleRate) This field can only be specified if logging is enabled for this backend service.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BackendServiceLogConfig

public BackendServiceLogConfig()

Method Detail

getEnable

public Boolean getEnable()

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

Returns:

value or null for none

setEnable

public BackendServiceLogConfig setEnable(Boolean enable)

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

Parameters:

enable - enable or null for none

getOptionalFields

public List<String> 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

Returns:

value or null for none

setOptionalFields

public BackendServiceLogConfig setOptionalFields(List<String> optionalFields)

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

Parameters:

optionalFields - optionalFields or null for none

getOptionalMode

public String 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.

Returns:

value or null for none

setOptionalMode

public BackendServiceLogConfig setOptionalMode(String 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.

Parameters:

optionalMode - optionalMode or null for none

getSampleRate

public Float 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.

Returns:

value or null for none

setSampleRate

public BackendServiceLogConfig setSampleRate(Float sampleRate)

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.

Parameters:

sampleRate - sampleRate or null for none

set

public BackendServiceLogConfig set(String fieldName,
                                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BackendServiceLogConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson