io.envoyproxy.envoy.config.accesslog.v3

Class RuntimeFilter.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

io.envoyproxy.envoy.config.accesslog.v3.RuntimeFilter.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RuntimeFilterOrBuilder, Cloneable

Enclosing class:

RuntimeFilter

public static final class RuntimeFilter.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>
implements RuntimeFilterOrBuilder

 Filters for random sampling of requests.
 

Protobuf type envoy.config.accesslog.v3.RuntimeFilter

Method Summary

Modifier and Type	Method and Description
RuntimeFilter.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RuntimeFilter	build()
RuntimeFilter	buildPartial()
RuntimeFilter.Builder	clear()
RuntimeFilter.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RuntimeFilter.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RuntimeFilter.Builder	clearPercentSampled() The default sampling percentage.
RuntimeFilter.Builder	clearRuntimeKey() Runtime key to get an optional overridden numerator for use in the *percent_sampled* field.
RuntimeFilter.Builder	clearUseIndependentRandomness() By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present.
RuntimeFilter.Builder	clone()
RuntimeFilter	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
FractionalPercent	getPercentSampled() The default sampling percentage.
FractionalPercent.Builder	getPercentSampledBuilder() The default sampling percentage.
FractionalPercentOrBuilder	getPercentSampledOrBuilder() The default sampling percentage.
String	getRuntimeKey() Runtime key to get an optional overridden numerator for use in the *percent_sampled* field.
com.google.protobuf.ByteString	getRuntimeKeyBytes() Runtime key to get an optional overridden numerator for use in the *percent_sampled* field.
boolean	getUseIndependentRandomness() By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present.
boolean	hasPercentSampled() The default sampling percentage.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RuntimeFilter.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RuntimeFilter.Builder	mergeFrom(com.google.protobuf.Message other)
RuntimeFilter.Builder	mergeFrom(RuntimeFilter other)
RuntimeFilter.Builder	mergePercentSampled(FractionalPercent value) The default sampling percentage.
RuntimeFilter.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RuntimeFilter.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RuntimeFilter.Builder	setPercentSampled(FractionalPercent.Builder builderForValue) The default sampling percentage.
RuntimeFilter.Builder	setPercentSampled(FractionalPercent value) The default sampling percentage.
RuntimeFilter.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RuntimeFilter.Builder	setRuntimeKey(String value) Runtime key to get an optional overridden numerator for use in the *percent_sampled* field.
RuntimeFilter.Builder	setRuntimeKeyBytes(com.google.protobuf.ByteString value) Runtime key to get an optional overridden numerator for use in the *percent_sampled* field.
RuntimeFilter.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RuntimeFilter.Builder	setUseIndependentRandomness(boolean value) By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

clear

public RuntimeFilter.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

getDefaultInstanceForType

public RuntimeFilter getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RuntimeFilter build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RuntimeFilter buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RuntimeFilter.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

setField

public RuntimeFilter.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

clearField

public RuntimeFilter.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

clearOneof

public RuntimeFilter.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

setRepeatedField

public RuntimeFilter.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

addRepeatedField

public RuntimeFilter.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

mergeFrom

public RuntimeFilter.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RuntimeFilter.Builder>

mergeFrom

public RuntimeFilter.Builder mergeFrom(RuntimeFilter other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

mergeFrom

public RuntimeFilter.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RuntimeFilter.Builder>

Throws:

IOException

getRuntimeKey

public String getRuntimeKey()

 Runtime key to get an optional overridden numerator for use in the
 *percent_sampled* field. If found in runtime, this value will replace the
 default numerator.
 

string runtime_key = 1 [(.validate.rules) = { ... }

Specified by:

getRuntimeKey in interface RuntimeFilterOrBuilder

getRuntimeKeyBytes

public com.google.protobuf.ByteString getRuntimeKeyBytes()

 Runtime key to get an optional overridden numerator for use in the
 *percent_sampled* field. If found in runtime, this value will replace the
 default numerator.
 

string runtime_key = 1 [(.validate.rules) = { ... }

Specified by:

getRuntimeKeyBytes in interface RuntimeFilterOrBuilder

setRuntimeKey

public RuntimeFilter.Builder setRuntimeKey(String value)

 Runtime key to get an optional overridden numerator for use in the
 *percent_sampled* field. If found in runtime, this value will replace the
 default numerator.
 

string runtime_key = 1 [(.validate.rules) = { ... }

clearRuntimeKey

public RuntimeFilter.Builder clearRuntimeKey()

 Runtime key to get an optional overridden numerator for use in the
 *percent_sampled* field. If found in runtime, this value will replace the
 default numerator.
 

string runtime_key = 1 [(.validate.rules) = { ... }

setRuntimeKeyBytes

public RuntimeFilter.Builder setRuntimeKeyBytes(com.google.protobuf.ByteString value)

 Runtime key to get an optional overridden numerator for use in the
 *percent_sampled* field. If found in runtime, this value will replace the
 default numerator.
 

string runtime_key = 1 [(.validate.rules) = { ... }

hasPercentSampled

public boolean hasPercentSampled()

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

Specified by:

hasPercentSampled in interface RuntimeFilterOrBuilder

getPercentSampled

public FractionalPercent getPercentSampled()

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

Specified by:

getPercentSampled in interface RuntimeFilterOrBuilder

setPercentSampled

public RuntimeFilter.Builder setPercentSampled(FractionalPercent value)

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

setPercentSampled

public RuntimeFilter.Builder setPercentSampled(FractionalPercent.Builder builderForValue)

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

mergePercentSampled

public RuntimeFilter.Builder mergePercentSampled(FractionalPercent value)

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

clearPercentSampled

public RuntimeFilter.Builder clearPercentSampled()

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

getPercentSampledBuilder

public FractionalPercent.Builder getPercentSampledBuilder()

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

getPercentSampledOrBuilder

public FractionalPercentOrBuilder getPercentSampledOrBuilder()

 The default sampling percentage. If not specified, defaults to 0% with
 denominator of 100.
 

.envoy.type.v3.FractionalPercent percent_sampled = 2;

Specified by:

getPercentSampledOrBuilder in interface RuntimeFilterOrBuilder

getUseIndependentRandomness

public boolean getUseIndependentRandomness()

 By default, sampling pivots on the header
 :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being
 present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`
 is present, the filter will consistently sample across multiple hosts based
 on the runtime key value and the value extracted from
 :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is
 missing, or *use_independent_randomness* is set to true, the filter will
 randomly sample based on the runtime key value alone.
 *use_independent_randomness* can be used for logging kill switches within
 complex nested :ref:`AndFilter
 <envoy_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter
 <envoy_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to
 reason about from a probability perspective (i.e., setting to true will
 cause the filter to behave like an independent random variable when
 composed within logical operator filters).
 

bool use_independent_randomness = 3;

Specified by:

getUseIndependentRandomness in interface RuntimeFilterOrBuilder

setUseIndependentRandomness

public RuntimeFilter.Builder setUseIndependentRandomness(boolean value)

 By default, sampling pivots on the header
 :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being
 present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`
 is present, the filter will consistently sample across multiple hosts based
 on the runtime key value and the value extracted from
 :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is
 missing, or *use_independent_randomness* is set to true, the filter will
 randomly sample based on the runtime key value alone.
 *use_independent_randomness* can be used for logging kill switches within
 complex nested :ref:`AndFilter
 <envoy_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter
 <envoy_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to
 reason about from a probability perspective (i.e., setting to true will
 cause the filter to behave like an independent random variable when
 composed within logical operator filters).
 

bool use_independent_randomness = 3;

clearUseIndependentRandomness

public RuntimeFilter.Builder clearUseIndependentRandomness()

 By default, sampling pivots on the header
 :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being
 present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`
 is present, the filter will consistently sample across multiple hosts based
 on the runtime key value and the value extracted from
 :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is
 missing, or *use_independent_randomness* is set to true, the filter will
 randomly sample based on the runtime key value alone.
 *use_independent_randomness* can be used for logging kill switches within
 complex nested :ref:`AndFilter
 <envoy_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter
 <envoy_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to
 reason about from a probability perspective (i.e., setting to true will
 cause the filter to behave like an independent random variable when
 composed within logical operator filters).
 

bool use_independent_randomness = 3;

setUnknownFields

public final RuntimeFilter.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>

mergeUnknownFields

public final RuntimeFilter.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RuntimeFilter.Builder>