Class BackendServiceLogConfig.Builder (1.49.0)

public static final class BackendServiceLogConfig.Builder extends GeneratedMessageV3.Builder<BackendServiceLogConfig.Builder> implements BackendServiceLogConfigOrBuilder

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

Protobuf type google.cloud.compute.v1.BackendServiceLogConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllOptionalFields(Iterable<String> values)

public BackendServiceLogConfig.Builder addAllOptionalFields(Iterable<String> values)

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

repeated string optional_fields = 528589944;

Parameter
NameDescription
valuesIterable<String>

The optionalFields to add.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

addOptionalFields(String value)

public BackendServiceLogConfig.Builder addOptionalFields(String value)

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

repeated string optional_fields = 528589944;

Parameter
NameDescription
valueString

The optionalFields to add.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

addOptionalFieldsBytes(ByteString value)

public BackendServiceLogConfig.Builder addOptionalFieldsBytes(ByteString value)

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

repeated string optional_fields = 528589944;

Parameter
NameDescription
valueByteString

The bytes of the optionalFields to add.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceLogConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

build()

public BackendServiceLogConfig build()
Returns
TypeDescription
BackendServiceLogConfig

buildPartial()

public BackendServiceLogConfig buildPartial()
Returns
TypeDescription
BackendServiceLogConfig

clear()

public BackendServiceLogConfig.Builder clear()
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

clearEnable()

public BackendServiceLogConfig.Builder clearEnable()

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

optional bool enable = 311764355;

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackendServiceLogConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendServiceLogConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

clearOptionalFields()

public BackendServiceLogConfig.Builder clearOptionalFields()

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

repeated string optional_fields = 528589944;

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

clearOptionalMode()

public BackendServiceLogConfig.Builder clearOptionalMode()

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 string optional_mode = 128697122;

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

clearSampleRate()

public BackendServiceLogConfig.Builder clearSampleRate()

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.

optional float sample_rate = 153193045;

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

clone()

public BackendServiceLogConfig.Builder clone()
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

getDefaultInstanceForType()

public BackendServiceLogConfig getDefaultInstanceForType()
Returns
TypeDescription
BackendServiceLogConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnable()

public boolean getEnable()

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

optional bool enable = 311764355;

Returns
TypeDescription
boolean

The enable.

getOptionalFields(int index)

public String getOptionalFields(int index)

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

repeated string optional_fields = 528589944;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The optionalFields at the given index.

getOptionalFieldsBytes(int index)

public ByteString getOptionalFieldsBytes(int index)

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

repeated string optional_fields = 528589944;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the optionalFields at the given index.

getOptionalFieldsCount()

public int getOptionalFieldsCount()

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

repeated string optional_fields = 528589944;

Returns
TypeDescription
int

The count of optionalFields.

getOptionalFieldsList()

public ProtocolStringList getOptionalFieldsList()

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

repeated string optional_fields = 528589944;

Returns
TypeDescription
ProtocolStringList

A list containing the optionalFields.

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. Check the OptionalMode enum for the list of possible values.

optional string optional_mode = 128697122;

Returns
TypeDescription
String

The optionalMode.

getOptionalModeBytes()

public ByteString getOptionalModeBytes()

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 string optional_mode = 128697122;

Returns
TypeDescription
ByteString

The bytes for optionalMode.

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.

optional float sample_rate = 153193045;

Returns
TypeDescription
float

The sampleRate.

hasEnable()

public boolean hasEnable()

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

optional bool enable = 311764355;

Returns
TypeDescription
boolean

Whether the enable field is set.

hasOptionalMode()

public boolean hasOptionalMode()

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 string optional_mode = 128697122;

Returns
TypeDescription
boolean

Whether the optionalMode field is set.

hasSampleRate()

public boolean hasSampleRate()

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.

optional float sample_rate = 153193045;

Returns
TypeDescription
boolean

Whether the sampleRate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BackendServiceLogConfig other)

public BackendServiceLogConfig.Builder mergeFrom(BackendServiceLogConfig other)
Parameter
NameDescription
otherBackendServiceLogConfig
Returns
TypeDescription
BackendServiceLogConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendServiceLogConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BackendServiceLogConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceLogConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

setEnable(boolean value)

public BackendServiceLogConfig.Builder setEnable(boolean value)

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

optional bool enable = 311764355;

Parameter
NameDescription
valueboolean

The enable to set.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceLogConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

setOptionalFields(int index, String value)

public BackendServiceLogConfig.Builder setOptionalFields(int index, String value)

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

repeated string optional_fields = 528589944;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The optionalFields to set.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

setOptionalMode(String value)

public BackendServiceLogConfig.Builder setOptionalMode(String value)

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 string optional_mode = 128697122;

Parameter
NameDescription
valueString

The optionalMode to set.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

setOptionalModeBytes(ByteString value)

public BackendServiceLogConfig.Builder setOptionalModeBytes(ByteString value)

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 string optional_mode = 128697122;

Parameter
NameDescription
valueByteString

The bytes for optionalMode to set.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackendServiceLogConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides

setSampleRate(float value)

public BackendServiceLogConfig.Builder setSampleRate(float value)

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.

optional float sample_rate = 153193045;

Parameter
NameDescription
valuefloat

The sampleRate to set.

Returns
TypeDescription
BackendServiceLogConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceLogConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackendServiceLogConfig.Builder
Overrides