io.envoyproxy.envoy.config.tap.v3

Class TapConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.tap.v3.TapConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TapConfigOrBuilder, Serializable

public final class TapConfig
extends com.google.protobuf.GeneratedMessageV3
implements TapConfigOrBuilder

 Tap configuration.
 

Protobuf type envoy.config.tap.v3.TapConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TapConfig.Builder Tap configuration.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	MATCH_CONFIG_FIELD_NUMBER
static int	MATCH_FIELD_NUMBER
static int	OUTPUT_CONFIG_FIELD_NUMBER
static int	TAP_ENABLED_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static TapConfig	getDefaultInstance()
TapConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
MatchPredicate	getMatch() The match configuration.
MatchPredicate	getMatchConfig() Deprecated.
MatchPredicateOrBuilder	getMatchConfigOrBuilder() Deprecated.
MatchPredicateOrBuilder	getMatchOrBuilder() The match configuration.
OutputConfig	getOutputConfig() The tap output configuration.
OutputConfigOrBuilder	getOutputConfigOrBuilder() The tap output configuration.
com.google.protobuf.Parser<TapConfig>	getParserForType()
int	getSerializedSize()
RuntimeFractionalPercent	getTapEnabled() [#not-implemented-hide:] Specify if Tap matching is enabled.
RuntimeFractionalPercentOrBuilder	getTapEnabledOrBuilder() [#not-implemented-hide:] Specify if Tap matching is enabled.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMatch() The match configuration.
boolean	hasMatchConfig() Deprecated.
boolean	hasOutputConfig() The tap output configuration.
boolean	hasTapEnabled() [#not-implemented-hide:] Specify if Tap matching is enabled.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TapConfig.Builder	newBuilder()
static TapConfig.Builder	newBuilder(TapConfig prototype)
TapConfig.Builder	newBuilderForType()
protected TapConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TapConfig	parseDelimitedFrom(InputStream input)
static TapConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TapConfig	parseFrom(byte[] data)
static TapConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TapConfig	parseFrom(ByteBuffer data)
static TapConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TapConfig	parseFrom(com.google.protobuf.ByteString data)
static TapConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TapConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static TapConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TapConfig	parseFrom(InputStream input)
static TapConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TapConfig>	parser()
TapConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MATCH_CONFIG_FIELD_NUMBER

public static final int MATCH_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

MATCH_FIELD_NUMBER

public static final int MATCH_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

TAP_ENABLED_FIELD_NUMBER

public static final int TAP_ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

hasMatchConfig

@Deprecated
public boolean hasMatchConfig()

Deprecated.

 The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` will be used.
 

.envoy.config.tap.v3.MatchPredicate match_config = 1 [deprecated = true];

Specified by:

hasMatchConfig in interface TapConfigOrBuilder

getMatchConfig

@Deprecated
public MatchPredicate getMatchConfig()

Deprecated.

 The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` will be used.
 

.envoy.config.tap.v3.MatchPredicate match_config = 1 [deprecated = true];

Specified by:

getMatchConfig in interface TapConfigOrBuilder

getMatchConfigOrBuilder

@Deprecated
public MatchPredicateOrBuilder getMatchConfigOrBuilder()

Deprecated.

 The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` will be used.
 

.envoy.config.tap.v3.MatchPredicate match_config = 1 [deprecated = true];

Specified by:

getMatchConfigOrBuilder in interface TapConfigOrBuilder

hasMatch

public boolean hasMatch()

 The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` will be used.
 

.envoy.config.common.matcher.v3.MatchPredicate match = 4;

Specified by:

hasMatch in interface TapConfigOrBuilder

getMatch

public MatchPredicate getMatch()

 The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` will be used.
 

.envoy.config.common.matcher.v3.MatchPredicate match = 4;

Specified by:

getMatch in interface TapConfigOrBuilder

getMatchOrBuilder

public MatchPredicateOrBuilder getMatchOrBuilder()

 The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_api_field_config.tap.v3.TapConfig.match>` will be used.
 

.envoy.config.common.matcher.v3.MatchPredicate match = 4;

Specified by:

getMatchOrBuilder in interface TapConfigOrBuilder

hasOutputConfig

public boolean hasOutputConfig()

 The tap output configuration. If a match configuration matches a data source being tapped,
 a tap will occur and the data will be written to the configured output.
 

.envoy.config.tap.v3.OutputConfig output_config = 2 [(.validate.rules) = { ... }

Specified by:

hasOutputConfig in interface TapConfigOrBuilder

getOutputConfig

public OutputConfig getOutputConfig()

 The tap output configuration. If a match configuration matches a data source being tapped,
 a tap will occur and the data will be written to the configured output.
 

.envoy.config.tap.v3.OutputConfig output_config = 2 [(.validate.rules) = { ... }

Specified by:

getOutputConfig in interface TapConfigOrBuilder

getOutputConfigOrBuilder

public OutputConfigOrBuilder getOutputConfigOrBuilder()

 The tap output configuration. If a match configuration matches a data source being tapped,
 a tap will occur and the data will be written to the configured output.
 

.envoy.config.tap.v3.OutputConfig output_config = 2 [(.validate.rules) = { ... }

Specified by:

getOutputConfigOrBuilder in interface TapConfigOrBuilder

hasTapEnabled

public boolean hasTapEnabled()

 [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
 which the tap matching is enabled. When not enabled, the request\connection will not be
 recorded.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.v3.FractionalPercent.DenominatorType>`.
 

.envoy.config.core.v3.RuntimeFractionalPercent tap_enabled = 3;

Specified by:

hasTapEnabled in interface TapConfigOrBuilder

getTapEnabled

public RuntimeFractionalPercent getTapEnabled()

 [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
 which the tap matching is enabled. When not enabled, the request\connection will not be
 recorded.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.v3.FractionalPercent.DenominatorType>`.
 

.envoy.config.core.v3.RuntimeFractionalPercent tap_enabled = 3;

Specified by:

getTapEnabled in interface TapConfigOrBuilder

getTapEnabledOrBuilder

public RuntimeFractionalPercentOrBuilder getTapEnabledOrBuilder()

 [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
 which the tap matching is enabled. When not enabled, the request\connection will not be
 recorded.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.v3.FractionalPercent.DenominatorType>`.
 

.envoy.config.core.v3.RuntimeFractionalPercent tap_enabled = 3;

Specified by:

getTapEnabledOrBuilder in interface TapConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TapConfig parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TapConfig parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TapConfig parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TapConfig parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TapConfig parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TapConfig parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TapConfig parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static TapConfig parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static TapConfig parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static TapConfig parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static TapConfig parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static TapConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public TapConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TapConfig.Builder newBuilder()

newBuilder

public static TapConfig.Builder newBuilder(TapConfig prototype)

toBuilder

public TapConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TapConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TapConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<TapConfig> parser()

getParserForType

public com.google.protobuf.Parser<TapConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TapConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder