Package io.envoyproxy.envoy.extensions.filters.http.file_system_buffer.v3

Class FileSystemBufferFilterConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FileSystemBufferFilterConfigOrBuilder, Serializable
    public final class FileSystemBufferFilterConfig
extends com.google.protobuf.GeneratedMessageV3
implements FileSystemBufferFilterConfigOrBuilder
     A :ref:`file system buffer <config_http_filters_file_system_buffer>` filter configuration.
 Route-specific configs override only the fields they explicitly include; unset
 fields inherit from the vhost or listener-level config, or, if never set,
 and not required, use a default value.
    Protobuf type envoy.extensions.filters.http.file_system_buffer.v3.FileSystemBufferFilterConfig
    See Also:
    Serialized Form

    • Field Detail

      • MANAGER_CONFIG_FIELD_NUMBER

        public static final int MANAGER_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STORAGE_BUFFER_PATH_FIELD_NUMBER

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

      • hasManagerConfig

        public boolean hasManagerConfig()
         A configuration for an AsyncFileManager.
 If unset in route, vhost and listener, and the behavior is not ``bypass``
 in both directions, an Internal Server Error response will be sent.
        .envoy.extensions.common.async_files.v3.AsyncFileManagerConfig manager_config = 1;
        Specified by:
        hasManagerConfig in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        Whether the managerConfig field is set.

      • getManagerConfig

        public AsyncFileManagerConfig getManagerConfig()
         A configuration for an AsyncFileManager.
 If unset in route, vhost and listener, and the behavior is not ``bypass``
 in both directions, an Internal Server Error response will be sent.
        .envoy.extensions.common.async_files.v3.AsyncFileManagerConfig manager_config = 1;
        Specified by:
        getManagerConfig in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        The managerConfig.

      • hasStorageBufferPath

        public boolean hasStorageBufferPath()
         An optional path to which the unlinked files should be written - this may
 determine which physical storage device will be used.
 If unset in route, vhost and listener, will use the environment variable
 ``TMPDIR``, or, if that's also unset, will use ``/tmp``.
        .google.protobuf.StringValue storage_buffer_path = 2;
        Specified by:
        hasStorageBufferPath in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        Whether the storageBufferPath field is set.

      • getStorageBufferPath

        public com.google.protobuf.StringValue getStorageBufferPath()
         An optional path to which the unlinked files should be written - this may
 determine which physical storage device will be used.
 If unset in route, vhost and listener, will use the environment variable
 ``TMPDIR``, or, if that's also unset, will use ``/tmp``.
        .google.protobuf.StringValue storage_buffer_path = 2;
        Specified by:
        getStorageBufferPath in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        The storageBufferPath.

      • getStorageBufferPathOrBuilder

        public com.google.protobuf.StringValueOrBuilder getStorageBufferPathOrBuilder()
         An optional path to which the unlinked files should be written - this may
 determine which physical storage device will be used.
 If unset in route, vhost and listener, will use the environment variable
 ``TMPDIR``, or, if that's also unset, will use ``/tmp``.
        .google.protobuf.StringValue storage_buffer_path = 2;
        Specified by:
        getStorageBufferPathOrBuilder in interface FileSystemBufferFilterConfigOrBuilder

      • hasRequest

        public boolean hasRequest()
         Optional configuration for how to buffer (or not) requests.
 If unset in route, vhost and listener, ``StreamConfig`` default values will be used
 (with behavior ``stream_when_possible``)
        .envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig request = 3;
        Specified by:
        hasRequest in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        Whether the request field is set.

      • getRequest

        public StreamConfig getRequest()
         Optional configuration for how to buffer (or not) requests.
 If unset in route, vhost and listener, ``StreamConfig`` default values will be used
 (with behavior ``stream_when_possible``)
        .envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig request = 3;
        Specified by:
        getRequest in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        The request.

      • getRequestOrBuilder

        public StreamConfigOrBuilder getRequestOrBuilder()
         Optional configuration for how to buffer (or not) requests.
 If unset in route, vhost and listener, ``StreamConfig`` default values will be used
 (with behavior ``stream_when_possible``)
        .envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig request = 3;
        Specified by:
        getRequestOrBuilder in interface FileSystemBufferFilterConfigOrBuilder

      • hasResponse

        public boolean hasResponse()
         Optional configuration for how to buffer (or not) responses.
 If unset in route, vhost and listener, ``StreamConfig`` default values will be used
 (with behavior ``stream_when_possible``)
        .envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig response = 4;
        Specified by:
        hasResponse in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        Whether the response field is set.

      • getResponse

        public StreamConfig getResponse()
         Optional configuration for how to buffer (or not) responses.
 If unset in route, vhost and listener, ``StreamConfig`` default values will be used
 (with behavior ``stream_when_possible``)
        .envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig response = 4;
        Specified by:
        getResponse in interface FileSystemBufferFilterConfigOrBuilder
        Returns:
        The response.

      • getResponseOrBuilder

        public StreamConfigOrBuilder getResponseOrBuilder()
         Optional configuration for how to buffer (or not) responses.
 If unset in route, vhost and listener, ``StreamConfig`` default values will be used
 (with behavior ``stream_when_possible``)
        .envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig response = 4;
        Specified by:
        getResponseOrBuilder in interface FileSystemBufferFilterConfigOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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