Package io.envoyproxy.envoy.config.bootstrap.v2

Class Runtime

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RuntimeOrBuilder, Serializable
    public final class Runtime
extends com.google.protobuf.GeneratedMessageV3
implements RuntimeOrBuilder
     Runtime :ref:`configuration overview <config_runtime>` (deprecated).
    Protobuf type envoy.config.bootstrap.v2.Runtime
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Runtime.Builder
      Runtime :ref:`configuration overview <config_runtime>` (deprecated).

      • 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)  
      com.google.protobuf.Struct getBase()
      Static base runtime.
      com.google.protobuf.StructOrBuilder getBaseOrBuilder()
      Static base runtime.
      static Runtime getDefaultInstance()  
      Runtime getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getOverrideSubdirectory()
      Specifies an optional subdirectory to load within the root directory.
      com.google.protobuf.ByteString getOverrideSubdirectoryBytes()
      Specifies an optional subdirectory to load within the root directory.
      com.google.protobuf.Parser<Runtime> getParserForType()  
      int getSerializedSize()  
      String getSubdirectory()
      Specifies the subdirectory to load within the root directory.
      com.google.protobuf.ByteString getSubdirectoryBytes()
      Specifies the subdirectory to load within the root directory.
      String getSymlinkRoot()
      The implementation assumes that the file system tree is accessed via a symbolic link.
      com.google.protobuf.ByteString getSymlinkRootBytes()
      The implementation assumes that the file system tree is accessed via a symbolic link.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasBase()
      Static base runtime.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Runtime.Builder newBuilder()  
      static Runtime.Builder newBuilder​(Runtime prototype)  
      Runtime.Builder newBuilderForType()  
      protected Runtime.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Runtime parseDelimitedFrom​(InputStream input)  
      static Runtime parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runtime parseFrom​(byte[] data)  
      static Runtime parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runtime parseFrom​(com.google.protobuf.ByteString data)  
      static Runtime parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runtime parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Runtime parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runtime parseFrom​(InputStream input)  
      static Runtime parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runtime parseFrom​(ByteBuffer data)  
      static Runtime parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Runtime> parser()  
      Runtime.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

    • Field Detail

      • SYMLINK_ROOT_FIELD_NUMBER

        public static final int SYMLINK_ROOT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUBDIRECTORY_FIELD_NUMBER

        public static final int SUBDIRECTORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OVERRIDE_SUBDIRECTORY_FIELD_NUMBER

        public static final int OVERRIDE_SUBDIRECTORY_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

      • getSymlinkRoot

        public String getSymlinkRoot()
         The implementation assumes that the file system tree is accessed via a
 symbolic link. An atomic link swap is used when a new tree should be
 switched to. This parameter specifies the path to the symbolic link. Envoy
 will watch the location for changes and reload the file system tree when
 they happen. If this parameter is not set, there will be no disk based
 runtime.
        string symlink_root = 1;
        Specified by:
        getSymlinkRoot in interface RuntimeOrBuilder
        Returns:
        The symlinkRoot.

      • getSymlinkRootBytes

        public com.google.protobuf.ByteString getSymlinkRootBytes()
         The implementation assumes that the file system tree is accessed via a
 symbolic link. An atomic link swap is used when a new tree should be
 switched to. This parameter specifies the path to the symbolic link. Envoy
 will watch the location for changes and reload the file system tree when
 they happen. If this parameter is not set, there will be no disk based
 runtime.
        string symlink_root = 1;
        Specified by:
        getSymlinkRootBytes in interface RuntimeOrBuilder
        Returns:
        The bytes for symlinkRoot.

      • getSubdirectory

        public String getSubdirectory()
         Specifies the subdirectory to load within the root directory. This is
 useful if multiple systems share the same delivery mechanism. Envoy
 configuration elements can be contained in a dedicated subdirectory.
        string subdirectory = 2;
        Specified by:
        getSubdirectory in interface RuntimeOrBuilder
        Returns:
        The subdirectory.

      • getSubdirectoryBytes

        public com.google.protobuf.ByteString getSubdirectoryBytes()
         Specifies the subdirectory to load within the root directory. This is
 useful if multiple systems share the same delivery mechanism. Envoy
 configuration elements can be contained in a dedicated subdirectory.
        string subdirectory = 2;
        Specified by:
        getSubdirectoryBytes in interface RuntimeOrBuilder
        Returns:
        The bytes for subdirectory.

      • getOverrideSubdirectory

        public String getOverrideSubdirectory()
         Specifies an optional subdirectory to load within the root directory. If
 specified and the directory exists, configuration values within this
 directory will override those found in the primary subdirectory. This is
 useful when Envoy is deployed across many different types of servers.
 Sometimes it is useful to have a per service cluster directory for runtime
 configuration. See below for exactly how the override directory is used.
        string override_subdirectory = 3;
        Specified by:
        getOverrideSubdirectory in interface RuntimeOrBuilder
        Returns:
        The overrideSubdirectory.

      • getOverrideSubdirectoryBytes

        public com.google.protobuf.ByteString getOverrideSubdirectoryBytes()
         Specifies an optional subdirectory to load within the root directory. If
 specified and the directory exists, configuration values within this
 directory will override those found in the primary subdirectory. This is
 useful when Envoy is deployed across many different types of servers.
 Sometimes it is useful to have a per service cluster directory for runtime
 configuration. See below for exactly how the override directory is used.
        string override_subdirectory = 3;
        Specified by:
        getOverrideSubdirectoryBytes in interface RuntimeOrBuilder
        Returns:
        The bytes for overrideSubdirectory.

      • hasBase

        public boolean hasBase()
         Static base runtime. This will be :ref:`overridden
 <config_runtime_layering>` by other runtime layers, e.g.
 disk or admin. This follows the :ref:`runtime protobuf JSON representation
 encoding <config_runtime_proto_json>`.
        .google.protobuf.Struct base = 4;
        Specified by:
        hasBase in interface RuntimeOrBuilder
        Returns:
        Whether the base field is set.

      • getBase

        public com.google.protobuf.Struct getBase()
         Static base runtime. This will be :ref:`overridden
 <config_runtime_layering>` by other runtime layers, e.g.
 disk or admin. This follows the :ref:`runtime protobuf JSON representation
 encoding <config_runtime_proto_json>`.
        .google.protobuf.Struct base = 4;
        Specified by:
        getBase in interface RuntimeOrBuilder
        Returns:
        The base.

      • getBaseOrBuilder

        public com.google.protobuf.StructOrBuilder getBaseOrBuilder()
         Static base runtime. This will be :ref:`overridden
 <config_runtime_layering>` by other runtime layers, e.g.
 disk or admin. This follows the :ref:`runtime protobuf JSON representation
 encoding <config_runtime_proto_json>`.
        .google.protobuf.Struct base = 4;
        Specified by:
        getBaseOrBuilder in interface RuntimeOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Runtime getDefaultInstance()

      • parser

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

      • getParserForType

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