Package io.envoyproxy.envoy.extensions.access_loggers.file.v3

Class FileAccessLog

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FileAccessLogOrBuilder, java.io.Serializable
    public final class FileAccessLog
extends com.google.protobuf.GeneratedMessageV3
implements FileAccessLogOrBuilder
     Custom configuration for an :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`
 that writes log entries directly to a file. Configures the built-in ``envoy.access_loggers.file``
 AccessLog.
 [#next-free-field: 6]
    Protobuf type envoy.extensions.access_loggers.file.v3.FileAccessLog
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FileAccessLog.AccessLogFormatCase  
      static class  FileAccessLog.Builder
      Custom configuration for an :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>` that writes log entries directly to a file.

      • 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 Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      FileAccessLog.AccessLogFormatCase getAccessLogFormatCase()  
      static FileAccessLog getDefaultInstance()  
      FileAccessLog getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getFormat()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.
      com.google.protobuf.ByteString getFormatBytes()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.
      com.google.protobuf.Struct getJsonFormat()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated.
      com.google.protobuf.StructOrBuilder getJsonFormatOrBuilder()
      Deprecated.
      SubstitutionFormatString getLogFormat()
      Configuration to form access log data and format.
      SubstitutionFormatStringOrBuilder getLogFormatOrBuilder()
      Configuration to form access log data and format.
      com.google.protobuf.Parser<FileAccessLog> getParserForType()  
      java.lang.String getPath()
      A path to a local file to which to write the access log entries.
      com.google.protobuf.ByteString getPathBytes()
      A path to a local file to which to write the access log entries.
      int getSerializedSize()  
      com.google.protobuf.Struct getTypedJsonFormat()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated.
      com.google.protobuf.StructOrBuilder getTypedJsonFormatOrBuilder()
      Deprecated.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasFormat()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.
      int hashCode()  
      boolean hasJsonFormat()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated.
      boolean hasLogFormat()
      Configuration to form access log data and format.
      boolean hasTypedJsonFormat()
      Deprecated.
      envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static FileAccessLog.Builder newBuilder()  
      static FileAccessLog.Builder newBuilder​(FileAccessLog prototype)  
      FileAccessLog.Builder newBuilderForType()  
      protected FileAccessLog.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static FileAccessLog parseDelimitedFrom​(java.io.InputStream input)  
      static FileAccessLog parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FileAccessLog parseFrom​(byte[] data)  
      static FileAccessLog parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FileAccessLog parseFrom​(com.google.protobuf.ByteString data)  
      static FileAccessLog parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FileAccessLog parseFrom​(com.google.protobuf.CodedInputStream input)  
      static FileAccessLog parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FileAccessLog parseFrom​(java.io.InputStream input)  
      static FileAccessLog parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FileAccessLog parseFrom​(java.nio.ByteBuffer data)  
      static FileAccessLog parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<FileAccessLog> parser()  
      FileAccessLog.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 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, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.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

      • getPath

        public java.lang.String getPath()
         A path to a local file to which to write the access log entries.
        string path = 1 [(.validate.rules) = { ... }
        Specified by:
        getPath in interface FileAccessLogOrBuilder
        Returns:
        The path.

      • getPathBytes

        public com.google.protobuf.ByteString getPathBytes()
         A path to a local file to which to write the access log entries.
        string path = 1 [(.validate.rules) = { ... }
        Specified by:
        getPathBytes in interface FileAccessLogOrBuilder
        Returns:
        The bytes for path.

      • hasFormat

        @Deprecated
public boolean hasFormat()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=39
         Access log :ref:`format string<config_access_log_format_strings>`.
 Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a
 :ref:`default format <config_access_log_default_format>`.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        string format = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasFormat in interface FileAccessLogOrBuilder
        Returns:
        Whether the format field is set.

      • getFormat

        @Deprecated
public java.lang.String getFormat()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=39
         Access log :ref:`format string<config_access_log_format_strings>`.
 Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a
 :ref:`default format <config_access_log_default_format>`.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        string format = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getFormat in interface FileAccessLogOrBuilder
        Returns:
        The format.

      • getFormatBytes

        @Deprecated
public com.google.protobuf.ByteString getFormatBytes()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=39
         Access log :ref:`format string<config_access_log_format_strings>`.
 Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a
 :ref:`default format <config_access_log_default_format>`.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        string format = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getFormatBytes in interface FileAccessLogOrBuilder
        Returns:
        The bytes for format.

      • hasJsonFormat

        @Deprecated
public boolean hasJsonFormat()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=45
         Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        .google.protobuf.Struct json_format = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasJsonFormat in interface FileAccessLogOrBuilder
        Returns:
        Whether the jsonFormat field is set.

      • getJsonFormat

        @Deprecated
public com.google.protobuf.Struct getJsonFormat()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=45
         Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        .google.protobuf.Struct json_format = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getJsonFormat in interface FileAccessLogOrBuilder
        Returns:
        The jsonFormat.

      • getJsonFormatOrBuilder

        @Deprecated
public com.google.protobuf.StructOrBuilder getJsonFormatOrBuilder()
        Deprecated.
         Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        .google.protobuf.Struct json_format = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getJsonFormatOrBuilder in interface FileAccessLogOrBuilder

      • hasTypedJsonFormat

        @Deprecated
public boolean hasTypedJsonFormat()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=54
         Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are
 rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may
 be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the
 documentation for a specific command operator for details.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        .google.protobuf.Struct typed_json_format = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasTypedJsonFormat in interface FileAccessLogOrBuilder
        Returns:
        Whether the typedJsonFormat field is set.

      • getTypedJsonFormat

        @Deprecated
public com.google.protobuf.Struct getTypedJsonFormat()
        Deprecated.
        envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=54
         Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are
 rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may
 be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the
 documentation for a specific command operator for details.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        .google.protobuf.Struct typed_json_format = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getTypedJsonFormat in interface FileAccessLogOrBuilder
        Returns:
        The typedJsonFormat.

      • getTypedJsonFormatOrBuilder

        @Deprecated
public com.google.protobuf.StructOrBuilder getTypedJsonFormatOrBuilder()
        Deprecated.
         Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are
 rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may
 be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the
 documentation for a specific command operator for details.
 This field is deprecated.
 Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
        .google.protobuf.Struct typed_json_format = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getTypedJsonFormatOrBuilder in interface FileAccessLogOrBuilder

      • hasLogFormat

        public boolean hasLogFormat()
         Configuration to form access log data and format.
 If not specified, use :ref:`default format <config_access_log_default_format>`.
        .envoy.config.core.v3.SubstitutionFormatString log_format = 5 [(.validate.rules) = { ... }
        Specified by:
        hasLogFormat in interface FileAccessLogOrBuilder
        Returns:
        Whether the logFormat field is set.

      • getLogFormat

        public SubstitutionFormatString getLogFormat()
         Configuration to form access log data and format.
 If not specified, use :ref:`default format <config_access_log_default_format>`.
        .envoy.config.core.v3.SubstitutionFormatString log_format = 5 [(.validate.rules) = { ... }
        Specified by:
        getLogFormat in interface FileAccessLogOrBuilder
        Returns:
        The logFormat.

      • getLogFormatOrBuilder

        public SubstitutionFormatStringOrBuilder getLogFormatOrBuilder()
         Configuration to form access log data and format.
 If not specified, use :ref:`default format <config_access_log_default_format>`.
        .envoy.config.core.v3.SubstitutionFormatString log_format = 5 [(.validate.rules) = { ... }
        Specified by:
        getLogFormatOrBuilder in interface FileAccessLogOrBuilder

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(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 FileAccessLog parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static FileAccessLog getDefaultInstance()

      • parser

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

      • getParserForType

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