Class BackendServiceLogConfig.Builder (1.58.0)

Version 1.58.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BackendServiceLogConfig.Builder

Implements

BackendServiceLogConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
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
Name	Description
values	Iterable<String> The optionalFields to add.

Returns
Type	Description
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
Name	Description
value	String The optionalFields to add.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes of the optionalFields to add.

Returns
Type	Description
BackendServiceLogConfig.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceLogConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public BackendServiceLogConfig build()

Returns
Type	Description
BackendServiceLogConfig

buildPartial()

public BackendServiceLogConfig buildPartial()

Returns
Type	Description
BackendServiceLogConfig

clear()

public BackendServiceLogConfig.Builder clear()

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
BackendServiceLogConfig.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackendServiceLogConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendServiceLogConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
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
Type	Description
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
Type	Description
BackendServiceLogConfig.Builder	This builder for chaining.

clone()

public BackendServiceLogConfig.Builder clone()

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public BackendServiceLogConfig getDefaultInstanceForType()

Returns
Type	Description
BackendServiceLogConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Type	Description
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
Name	Description
index	int The index of the element to return.

Returns
Type	Description
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
Name	Description
index	int The index of the value to return.

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
boolean	Whether the sampleRate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BackendServiceLogConfig other)

public BackendServiceLogConfig.Builder mergeFrom(BackendServiceLogConfig other)

Parameter
Name	Description
other	BackendServiceLogConfig

Returns
Type	Description
BackendServiceLogConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendServiceLogConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BackendServiceLogConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceLogConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
value	boolean The enable to set.

Returns
Type	Description
BackendServiceLogConfig.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceLogConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
index	int The index to set the value at.
value	String The optionalFields to set.

Returns
Type	Description
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
Name	Description
value	String The optionalMode to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for optionalMode to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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
Name	Description
value	float The sampleRate to set.

Returns
Type	Description
BackendServiceLogConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceLogConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BackendServiceLogConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)