Package io.envoyproxy.envoy.config.core.v3

Class DataSource

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DataSourceOrBuilder, java.io.Serializable
    public final class DataSource
extends com.google.protobuf.GeneratedMessage
implements DataSourceOrBuilder
     Data source consisting of a file, an inline value, or an environment variable.
 [#next-free-field: 6]
    Protobuf type envoy.config.core.v3.DataSource
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DataSource.Builder
      Data source consisting of a file, an inline value, or an environment variable.
      static class  DataSource.SpecifierCase  

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

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessage.BuilderParent

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private DataSource()  
      private DataSource​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static DataSource getDefaultInstance()  
      DataSource getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getEnvironmentVariable()
      Environment variable data source.
      com.google.protobuf.ByteString getEnvironmentVariableBytes()
      Environment variable data source.
      java.lang.String getFilename()
      Local filesystem data source.
      com.google.protobuf.ByteString getFilenameBytes()
      Local filesystem data source.
      com.google.protobuf.ByteString getInlineBytes()
      Bytes inlined in the configuration.
      java.lang.String getInlineString()
      String inlined in the configuration.
      com.google.protobuf.ByteString getInlineStringBytes()
      String inlined in the configuration.
      com.google.protobuf.Parser<DataSource> getParserForType()  
      int getSerializedSize()  
      DataSource.SpecifierCase getSpecifierCase()  
      WatchedDirectory getWatchedDirectory()
      Watched directory that is watched for file changes.
      WatchedDirectoryOrBuilder getWatchedDirectoryOrBuilder()
      Watched directory that is watched for file changes.
      boolean hasEnvironmentVariable()
      Environment variable data source.
      boolean hasFilename()
      Local filesystem data source.
      int hashCode()  
      boolean hasInlineBytes()
      Bytes inlined in the configuration.
      boolean hasInlineString()
      String inlined in the configuration.
      boolean hasWatchedDirectory()
      Watched directory that is watched for file changes.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static DataSource.Builder newBuilder()  
      static DataSource.Builder newBuilder​(DataSource prototype)  
      DataSource.Builder newBuilderForType()  
      protected DataSource.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static DataSource parseDelimitedFrom​(java.io.InputStream input)  
      static DataSource parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataSource parseFrom​(byte[] data)  
      static DataSource parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataSource parseFrom​(com.google.protobuf.ByteString data)  
      static DataSource parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataSource parseFrom​(com.google.protobuf.CodedInputStream input)  
      static DataSource parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataSource parseFrom​(java.io.InputStream input)  
      static DataSource parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataSource parseFrom​(java.nio.ByteBuffer data)  
      static DataSource parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<DataSource> parser()  
      DataSource.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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 Detail

      • bitField0_

        private int bitField0_

      • specifierCase_

        private int specifierCase_

      • specifier_

        private java.lang.Object specifier_

      • INLINE_BYTES_FIELD_NUMBER

        public static final int INLINE_BYTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INLINE_STRING_FIELD_NUMBER

        public static final int INLINE_STRING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENVIRONMENT_VARIABLE_FIELD_NUMBER

        public static final int ENVIRONMENT_VARIABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WATCHED_DIRECTORY_FIELD_NUMBER

        public static final int WATCHED_DIRECTORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final DataSource DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<DataSource> PARSER

    • Constructor Detail

      • DataSource

        private DataSource​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • DataSource

        private DataSource()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • hasFilename

        public boolean hasFilename()
         Local filesystem data source.
        string filename = 1 [(.validate.rules) = { ... }
        Specified by:
        hasFilename in interface DataSourceOrBuilder
        Returns:
        Whether the filename field is set.

      • getFilename

        public java.lang.String getFilename()
         Local filesystem data source.
        string filename = 1 [(.validate.rules) = { ... }
        Specified by:
        getFilename in interface DataSourceOrBuilder
        Returns:
        The filename.

      • getFilenameBytes

        public com.google.protobuf.ByteString getFilenameBytes()
         Local filesystem data source.
        string filename = 1 [(.validate.rules) = { ... }
        Specified by:
        getFilenameBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for filename.

      • hasInlineBytes

        public boolean hasInlineBytes()
         Bytes inlined in the configuration.
        bytes inline_bytes = 2;
        Specified by:
        hasInlineBytes in interface DataSourceOrBuilder
        Returns:
        Whether the inlineBytes field is set.

      • getInlineBytes

        public com.google.protobuf.ByteString getInlineBytes()
         Bytes inlined in the configuration.
        bytes inline_bytes = 2;
        Specified by:
        getInlineBytes in interface DataSourceOrBuilder
        Returns:
        The inlineBytes.

      • hasInlineString

        public boolean hasInlineString()
         String inlined in the configuration.
        string inline_string = 3;
        Specified by:
        hasInlineString in interface DataSourceOrBuilder
        Returns:
        Whether the inlineString field is set.

      • getInlineString

        public java.lang.String getInlineString()
         String inlined in the configuration.
        string inline_string = 3;
        Specified by:
        getInlineString in interface DataSourceOrBuilder
        Returns:
        The inlineString.

      • getInlineStringBytes

        public com.google.protobuf.ByteString getInlineStringBytes()
         String inlined in the configuration.
        string inline_string = 3;
        Specified by:
        getInlineStringBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for inlineString.

      • hasEnvironmentVariable

        public boolean hasEnvironmentVariable()
         Environment variable data source.
        string environment_variable = 4 [(.validate.rules) = { ... }
        Specified by:
        hasEnvironmentVariable in interface DataSourceOrBuilder
        Returns:
        Whether the environmentVariable field is set.

      • getEnvironmentVariable

        public java.lang.String getEnvironmentVariable()
         Environment variable data source.
        string environment_variable = 4 [(.validate.rules) = { ... }
        Specified by:
        getEnvironmentVariable in interface DataSourceOrBuilder
        Returns:
        The environmentVariable.

      • getEnvironmentVariableBytes

        public com.google.protobuf.ByteString getEnvironmentVariableBytes()
         Environment variable data source.
        string environment_variable = 4 [(.validate.rules) = { ... }
        Specified by:
        getEnvironmentVariableBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for environmentVariable.

      • hasWatchedDirectory

        public boolean hasWatchedDirectory()
         Watched directory that is watched for file changes. If this is set explicitly, the file
 specified in the ``filename`` field will be reloaded when relevant file move events occur.

 .. note::
 This field only makes sense when the ``filename`` field is set.

 .. note::
 Envoy only updates when the file is replaced by a file move, and not when the file is
 edited in place.

 .. note::
 Not all use cases of ``DataSource`` support watching directories. It depends on the
 specific usage of the ``DataSource``. See the documentation of the parent message for
 details.
        .envoy.config.core.v3.WatchedDirectory watched_directory = 5;
        Specified by:
        hasWatchedDirectory in interface DataSourceOrBuilder
        Returns:
        Whether the watchedDirectory field is set.

      • getWatchedDirectory

        public WatchedDirectory getWatchedDirectory()
         Watched directory that is watched for file changes. If this is set explicitly, the file
 specified in the ``filename`` field will be reloaded when relevant file move events occur.

 .. note::
 This field only makes sense when the ``filename`` field is set.

 .. note::
 Envoy only updates when the file is replaced by a file move, and not when the file is
 edited in place.

 .. note::
 Not all use cases of ``DataSource`` support watching directories. It depends on the
 specific usage of the ``DataSource``. See the documentation of the parent message for
 details.
        .envoy.config.core.v3.WatchedDirectory watched_directory = 5;
        Specified by:
        getWatchedDirectory in interface DataSourceOrBuilder
        Returns:
        The watchedDirectory.

      • getWatchedDirectoryOrBuilder

        public WatchedDirectoryOrBuilder getWatchedDirectoryOrBuilder()
         Watched directory that is watched for file changes. If this is set explicitly, the file
 specified in the ``filename`` field will be reloaded when relevant file move events occur.

 .. note::
 This field only makes sense when the ``filename`` field is set.

 .. note::
 Envoy only updates when the file is replaced by a file move, and not when the file is
 edited in place.

 .. note::
 Not all use cases of ``DataSource`` support watching directories. It depends on the
 specific usage of the ``DataSource``. See the documentation of the parent message for
 details.
        .envoy.config.core.v3.WatchedDirectory watched_directory = 5;
        Specified by:
        getWatchedDirectoryOrBuilder in interface DataSourceOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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 DataSource parseFrom​(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static DataSource parseFrom​(java.io.InputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static DataSource parseFrom​(java.io.InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DataSource parseDelimitedFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DataSource parseDelimitedFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static DataSource parseFrom​(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected DataSource.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static DataSource getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<DataSource> 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.GeneratedMessage

      • getDefaultInstanceForType

        public DataSource getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder