io.envoyproxy.envoy.extensions.filters.network.mongo_proxy.v3

Interface MongoProxyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

MongoProxy, MongoProxy.Builder

public interface MongoProxyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAccessLog() The optional path to use for writing Mongo access logs.
com.google.protobuf.ByteString	getAccessLogBytes() The optional path to use for writing Mongo access logs.
String	getCommands(int index) List of commands to emit metrics for.
com.google.protobuf.ByteString	getCommandsBytes(int index) List of commands to emit metrics for.
int	getCommandsCount() List of commands to emit metrics for.
List<String>	getCommandsList() List of commands to emit metrics for.
FaultDelay	getDelay() Inject a fixed delay before proxying a Mongo operation.
FaultDelayOrBuilder	getDelayOrBuilder() Inject a fixed delay before proxying a Mongo operation.
boolean	getEmitDynamicMetadata() Flag to specify whether :ref:`dynamic metadata <config_network_filters_mongo_proxy_dynamic_metadata>` should be emitted.
String	getStatPrefix() The human readable prefix to use when emitting :ref:`statistics <config_network_filters_mongo_proxy_stats>`.
com.google.protobuf.ByteString	getStatPrefixBytes() The human readable prefix to use when emitting :ref:`statistics <config_network_filters_mongo_proxy_stats>`.
boolean	hasDelay() Inject a fixed delay before proxying a Mongo operation.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getStatPrefix

String getStatPrefix()

 The human readable prefix to use when emitting :ref:`statistics
 <config_network_filters_mongo_proxy_stats>`.
 

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

getStatPrefixBytes

com.google.protobuf.ByteString getStatPrefixBytes()

 The human readable prefix to use when emitting :ref:`statistics
 <config_network_filters_mongo_proxy_stats>`.
 

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

getAccessLog

String getAccessLog()

 The optional path to use for writing Mongo access logs. If not access log
 path is specified no access logs will be written. Note that access log is
 also gated :ref:`runtime <config_network_filters_mongo_proxy_runtime>`.
 

string access_log = 2;

getAccessLogBytes

com.google.protobuf.ByteString getAccessLogBytes()

 The optional path to use for writing Mongo access logs. If not access log
 path is specified no access logs will be written. Note that access log is
 also gated :ref:`runtime <config_network_filters_mongo_proxy_runtime>`.
 

string access_log = 2;

hasDelay

boolean hasDelay()

 Inject a fixed delay before proxying a Mongo operation. Delays are
 applied to the following MongoDB operations: Query, Insert, GetMore,
 and KillCursors. Once an active delay is in progress, all incoming
 data up until the timer event fires will be a part of the delay.
 

.envoy.extensions.filters.common.fault.v3.FaultDelay delay = 3;

getDelay

FaultDelay getDelay()

 Inject a fixed delay before proxying a Mongo operation. Delays are
 applied to the following MongoDB operations: Query, Insert, GetMore,
 and KillCursors. Once an active delay is in progress, all incoming
 data up until the timer event fires will be a part of the delay.
 

.envoy.extensions.filters.common.fault.v3.FaultDelay delay = 3;

getDelayOrBuilder

FaultDelayOrBuilder getDelayOrBuilder()

 Inject a fixed delay before proxying a Mongo operation. Delays are
 applied to the following MongoDB operations: Query, Insert, GetMore,
 and KillCursors. Once an active delay is in progress, all incoming
 data up until the timer event fires will be a part of the delay.
 

.envoy.extensions.filters.common.fault.v3.FaultDelay delay = 3;

getEmitDynamicMetadata

boolean getEmitDynamicMetadata()

 Flag to specify whether :ref:`dynamic metadata
 <config_network_filters_mongo_proxy_dynamic_metadata>` should be emitted. Defaults to false.
 

bool emit_dynamic_metadata = 4;

getCommandsList

List<String> getCommandsList()

 List of commands to emit metrics for. Defaults to "delete", "insert", and "update".
 Note that metrics will not be emitted for "find" commands, since those are considered
 queries, and metrics for those are emitted under a dedicated "query" namespace.
 

repeated string commands = 5;

getCommandsCount

int getCommandsCount()

 List of commands to emit metrics for. Defaults to "delete", "insert", and "update".
 Note that metrics will not be emitted for "find" commands, since those are considered
 queries, and metrics for those are emitted under a dedicated "query" namespace.
 

repeated string commands = 5;

getCommands

String getCommands(int index)

 List of commands to emit metrics for. Defaults to "delete", "insert", and "update".
 Note that metrics will not be emitted for "find" commands, since those are considered
 queries, and metrics for those are emitted under a dedicated "query" namespace.
 

repeated string commands = 5;

getCommandsBytes

com.google.protobuf.ByteString getCommandsBytes(int index)

 List of commands to emit metrics for. Defaults to "delete", "insert", and "update".
 Note that metrics will not be emitted for "find" commands, since those are considered
 queries, and metrics for those are emitted under a dedicated "query" namespace.
 

repeated string commands = 5;