Class RuntimeFilter.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.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
,java.lang.Cloneable
- Enclosing class:
- RuntimeFilter
public static final class RuntimeFilter.Builder extends com.google.protobuf.GeneratedMessage.Builder<RuntimeFilter.Builder> implements RuntimeFilterOrBuilder
Filters for random sampling of requests.
Protobuf typeenvoy.config.accesslog.v3.RuntimeFilter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private FractionalPercent
percentSampled_
private com.google.protobuf.SingleFieldBuilder<FractionalPercent,FractionalPercent.Builder,FractionalPercentOrBuilder>
percentSampledBuilder_
private java.lang.Object
runtimeKey_
private boolean
useIndependentRandomness_
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RuntimeFilter
build()
RuntimeFilter
buildPartial()
private void
buildPartial0(RuntimeFilter result)
RuntimeFilter.Builder
clear()
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
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.private com.google.protobuf.SingleFieldBuilder<FractionalPercent,FractionalPercent.Builder,FractionalPercentOrBuilder>
getPercentSampledFieldBuilder()
The default sampling percentage.FractionalPercentOrBuilder
getPercentSampledOrBuilder()
The default sampling percentage.java.lang.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.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
private void
maybeForceBuilderInitialization()
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
setPercentSampled(FractionalPercent value)
The default sampling percentage.RuntimeFilter.Builder
setPercentSampled(FractionalPercent.Builder builderForValue)
The default sampling percentage.RuntimeFilter.Builder
setRuntimeKey(java.lang.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
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.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
bitField0_
private int bitField0_
-
runtimeKey_
private java.lang.Object runtimeKey_
-
percentSampled_
private FractionalPercent percentSampled_
-
percentSampledBuilder_
private com.google.protobuf.SingleFieldBuilder<FractionalPercent,FractionalPercent.Builder,FractionalPercentOrBuilder> percentSampledBuilder_
-
useIndependentRandomness_
private boolean useIndependentRandomness_
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<RuntimeFilter.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization()
-
clear
public RuntimeFilter.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<RuntimeFilter.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<RuntimeFilter.Builder>
-
getDefaultInstanceForType
public RuntimeFilter getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public RuntimeFilter build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public RuntimeFilter buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
private void buildPartial0(RuntimeFilter result)
-
mergeFrom
public RuntimeFilter.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RuntimeFilter.Builder>
-
mergeFrom
public RuntimeFilter.Builder mergeFrom(RuntimeFilter other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<RuntimeFilter.Builder>
-
mergeFrom
public RuntimeFilter.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RuntimeFilter.Builder>
- Throws:
java.io.IOException
-
getRuntimeKey
public java.lang.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 interfaceRuntimeFilterOrBuilder
- Returns:
- The runtimeKey.
-
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 interfaceRuntimeFilterOrBuilder
- Returns:
- The bytes for runtimeKey.
-
setRuntimeKey
public RuntimeFilter.Builder setRuntimeKey(java.lang.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) = { ... }
- Parameters:
value
- The runtimeKey to set.- Returns:
- This builder for chaining.
-
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) = { ... }
- Returns:
- This builder for chaining.
-
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) = { ... }
- Parameters:
value
- The bytes for runtimeKey to set.- Returns:
- This builder for chaining.
-
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 interfaceRuntimeFilterOrBuilder
- Returns:
- Whether the percentSampled field is set.
-
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 interfaceRuntimeFilterOrBuilder
- Returns:
- The percentSampled.
-
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 interfaceRuntimeFilterOrBuilder
-
getPercentSampledFieldBuilder
private com.google.protobuf.SingleFieldBuilder<FractionalPercent,FractionalPercent.Builder,FractionalPercentOrBuilder> getPercentSampledFieldBuilder()
The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
-
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_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter <envoy_v3_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 interfaceRuntimeFilterOrBuilder
- Returns:
- The useIndependentRandomness.
-
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_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter <envoy_v3_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;
- Parameters:
value
- The useIndependentRandomness to set.- Returns:
- This builder for chaining.
-
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_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter <envoy_v3_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;
- Returns:
- This builder for chaining.
-
-