Package io.envoyproxy.envoy.extensions.key_value.file_based.v3

Class FileBasedKeyValueStoreConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.key_value.file_based.v3.FileBasedKeyValueStoreConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FileBasedKeyValueStoreConfigOrBuilder, Serializable
public final class FileBasedKeyValueStoreConfig extends com.google.protobuf.GeneratedMessageV3 implements FileBasedKeyValueStoreConfigOrBuilder
 [#extension: envoy.key_value.file_based]
 This is configuration to flush a key value store out to disk.
Protobuf type envoy.extensions.key_value.file_based.v3.FileBasedKeyValueStoreConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FileBasedKeyValueStoreConfig.Builder
    [#extension: envoy.key_value.file_based] This is configuration to flush a key value store out to disk.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FILENAME_FIELD_NUMBER
     
    static final int
    FLUSH_INTERVAL_FIELD_NUMBER
     
    static final int
    MAX_ENTRIES_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
    Description
    boolean
    equals(Object obj)
     
    static FileBasedKeyValueStoreConfig
    getDefaultInstance()
     
    FileBasedKeyValueStoreConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFilename()
    The filename to read the keys and values from, and write the keys and values to.
    com.google.protobuf.ByteString
    getFilenameBytes()
    The filename to read the keys and values from, and write the keys and values to.
    com.google.protobuf.Duration
    getFlushInterval()
    The interval at which the key value store should be flushed to the file.
    com.google.protobuf.DurationOrBuilder
    getFlushIntervalOrBuilder()
    The interval at which the key value store should be flushed to the file.
    com.google.protobuf.UInt32Value
    getMaxEntries()
    The maximum number of entries to cache, or 0 to allow for unlimited entries.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxEntriesOrBuilder()
    The maximum number of entries to cache, or 0 to allow for unlimited entries.
    com.google.protobuf.Parser<FileBasedKeyValueStoreConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasFlushInterval()
    The interval at which the key value store should be flushed to the file.
    int
    hashCode()
     
    boolean
    hasMaxEntries()
    The maximum number of entries to cache, or 0 to allow for unlimited entries.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FileBasedKeyValueStoreConfig.Builder
    newBuilder()
     
    static FileBasedKeyValueStoreConfig.Builder
    newBuilder(FileBasedKeyValueStoreConfig prototype)
     
    FileBasedKeyValueStoreConfig.Builder
    newBuilderForType()
     
    protected FileBasedKeyValueStoreConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FileBasedKeyValueStoreConfig
    parseDelimitedFrom(InputStream input)
     
    static FileBasedKeyValueStoreConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(byte[] data)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(InputStream input)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(ByteBuffer data)
     
    static FileBasedKeyValueStoreConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FileBasedKeyValueStoreConfig>
    parser()
     
    FileBasedKeyValueStoreConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • FILENAME_FIELD_NUMBER

      public static final int FILENAME_FIELD_NUMBER
      See Also:

    • FLUSH_INTERVAL_FIELD_NUMBER

      public static final int FLUSH_INTERVAL_FIELD_NUMBER
      See Also:

    • MAX_ENTRIES_FIELD_NUMBER

      public static final int MAX_ENTRIES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getFilename

      public String getFilename()
       The filename to read the keys and values from, and write the keys and
 values to.
      string filename = 1 [(.validate.rules) = { ... }
      Specified by:
      getFilename in interface FileBasedKeyValueStoreConfigOrBuilder
      Returns:
      The filename.

    • getFilenameBytes

      public com.google.protobuf.ByteString getFilenameBytes()
       The filename to read the keys and values from, and write the keys and
 values to.
      string filename = 1 [(.validate.rules) = { ... }
      Specified by:
      getFilenameBytes in interface FileBasedKeyValueStoreConfigOrBuilder
      Returns:
      The bytes for filename.

    • hasFlushInterval

      public boolean hasFlushInterval()
       The interval at which the key value store should be flushed to the file.
      .google.protobuf.Duration flush_interval = 2;
      Specified by:
      hasFlushInterval in interface FileBasedKeyValueStoreConfigOrBuilder
      Returns:
      Whether the flushInterval field is set.

    • getFlushInterval

      public com.google.protobuf.Duration getFlushInterval()
       The interval at which the key value store should be flushed to the file.
      .google.protobuf.Duration flush_interval = 2;
      Specified by:
      getFlushInterval in interface FileBasedKeyValueStoreConfigOrBuilder
      Returns:
      The flushInterval.

    • getFlushIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getFlushIntervalOrBuilder()
       The interval at which the key value store should be flushed to the file.
      .google.protobuf.Duration flush_interval = 2;
      Specified by:
      getFlushIntervalOrBuilder in interface FileBasedKeyValueStoreConfigOrBuilder

    • hasMaxEntries

      public boolean hasMaxEntries()
       The maximum number of entries to cache, or 0 to allow for unlimited entries.
 Defaults to 1000 if not present.
      .google.protobuf.UInt32Value max_entries = 3;
      Specified by:
      hasMaxEntries in interface FileBasedKeyValueStoreConfigOrBuilder
      Returns:
      Whether the maxEntries field is set.

    • getMaxEntries

      public com.google.protobuf.UInt32Value getMaxEntries()
       The maximum number of entries to cache, or 0 to allow for unlimited entries.
 Defaults to 1000 if not present.
      .google.protobuf.UInt32Value max_entries = 3;
      Specified by:
      getMaxEntries in interface FileBasedKeyValueStoreConfigOrBuilder
      Returns:
      The maxEntries.

    • getMaxEntriesOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxEntriesOrBuilder()
       The maximum number of entries to cache, or 0 to allow for unlimited entries.
 Defaults to 1000 if not present.
      .google.protobuf.UInt32Value max_entries = 3;
      Specified by:
      getMaxEntriesOrBuilder in interface FileBasedKeyValueStoreConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FileBasedKeyValueStoreConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FileBasedKeyValueStoreConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static FileBasedKeyValueStoreConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FileBasedKeyValueStoreConfig.Builder newBuilder()

    • newBuilder

      public static FileBasedKeyValueStoreConfig.Builder newBuilder(FileBasedKeyValueStoreConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FileBasedKeyValueStoreConfig getDefaultInstance()

    • parser

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

    • getParserForType

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