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

Class MongoProxy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MongoProxyOrBuilder, Serializable
    public final class MongoProxy
extends com.google.protobuf.GeneratedMessageV3
implements MongoProxyOrBuilder
     [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.network.mongo_proxy.v3.MongoProxy
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MongoProxy.Builder
      [#next-free-field: 6]

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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.
      com.google.protobuf.ProtocolStringList getCommandsList()
      List of commands to emit metrics for.
      static MongoProxy getDefaultInstance()  
      MongoProxy getDefaultInstanceForType()  
      FaultDelay getDelay()
      Inject a fixed delay before proxying a Mongo operation.
      FaultDelayOrBuilder getDelayOrBuilder()
      Inject a fixed delay before proxying a Mongo operation.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getEmitDynamicMetadata()
      Flag to specify whether :ref:`dynamic metadata <config_network_filters_mongo_proxy_dynamic_metadata>` should be emitted.
      com.google.protobuf.Parser<MongoProxy> getParserForType()  
      int getSerializedSize()  
      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>`.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasDelay()
      Inject a fixed delay before proxying a Mongo operation.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MongoProxy.Builder newBuilder()  
      static MongoProxy.Builder newBuilder​(MongoProxy prototype)  
      MongoProxy.Builder newBuilderForType()  
      protected MongoProxy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static MongoProxy parseDelimitedFrom​(InputStream input)  
      static MongoProxy parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MongoProxy parseFrom​(byte[] data)  
      static MongoProxy parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MongoProxy parseFrom​(com.google.protobuf.ByteString data)  
      static MongoProxy parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MongoProxy parseFrom​(com.google.protobuf.CodedInputStream input)  
      static MongoProxy parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MongoProxy parseFrom​(InputStream input)  
      static MongoProxy parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MongoProxy parseFrom​(ByteBuffer data)  
      static MongoProxy parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<MongoProxy> parser()  
      MongoProxy.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, isStringEmpty, 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 interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • 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

      • getStatPrefix

        public String getStatPrefix()
         The human readable prefix to use when emitting :ref:`statistics
 <config_network_filters_mongo_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefix in interface MongoProxyOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        public 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) = { ... }
        Specified by:
        getStatPrefixBytes in interface MongoProxyOrBuilder
        Returns:
        The bytes for statPrefix.

      • getAccessLog

        public 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;
        Specified by:
        getAccessLog in interface MongoProxyOrBuilder
        Returns:
        The accessLog.

      • getAccessLogBytes

        public 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;
        Specified by:
        getAccessLogBytes in interface MongoProxyOrBuilder
        Returns:
        The bytes for accessLog.

      • hasDelay

        public 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;
        Specified by:
        hasDelay in interface MongoProxyOrBuilder
        Returns:
        Whether the delay field is set.

      • getDelay

        public 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;
        Specified by:
        getDelay in interface MongoProxyOrBuilder
        Returns:
        The delay.

      • getDelayOrBuilder

        public 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;
        Specified by:
        getDelayOrBuilder in interface MongoProxyOrBuilder

      • getEmitDynamicMetadata

        public 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;
        Specified by:
        getEmitDynamicMetadata in interface MongoProxyOrBuilder
        Returns:
        The emitDynamicMetadata.

      • getCommandsList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getCommandsList in interface MongoProxyOrBuilder
        Returns:
        A list containing the commands.

      • getCommandsCount

        public 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;
        Specified by:
        getCommandsCount in interface MongoProxyOrBuilder
        Returns:
        The count of commands.

      • getCommands

        public 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;
        Specified by:
        getCommands in interface MongoProxyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The commands at the given index.

      • getCommandsBytes

        public 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;
        Specified by:
        getCommandsBytes in interface MongoProxyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the commands at the given index.

      • 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 MongoProxy parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MongoProxy parseFrom​(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MongoProxy parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MongoProxy parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MongoProxy parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MongoProxy parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MongoProxy parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public MongoProxy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public MongoProxy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected MongoProxy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static MongoProxy getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<MongoProxy> 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 MongoProxy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder