Package io.envoyproxy.envoy.config.accesslog.v2

Class FileAccessLog

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.accesslog.v2.FileAccessLog
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FileAccessLogOrBuilder, Serializable
public final class FileAccessLog extends com.google.protobuf.GeneratedMessageV3 implements FileAccessLogOrBuilder
 Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>`
 that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file*
 AccessLog.
Protobuf type envoy.config.accesslog.v2.FileAccessLog
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    FileAccessLog.AccessLogFormatCase
     
    static final class 
    FileAccessLog.Builder
    Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.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<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
    FORMAT_FIELD_NUMBER
     
    static final int
    JSON_FORMAT_FIELD_NUMBER
     
    static final int
    PATH_FIELD_NUMBER
     
    static final int
    TYPED_JSON_FORMAT_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)
     
    FileAccessLog.AccessLogFormatCase
    getAccessLogFormatCase()
     
    static FileAccessLog
    getDefaultInstance()
     
    FileAccessLog
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFormat()
    Access log :ref:`format string<config_access_log_format_strings>`.
    com.google.protobuf.ByteString
    getFormatBytes()
    Access log :ref:`format string<config_access_log_format_strings>`.
    com.google.protobuf.Struct
    getJsonFormat()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    com.google.protobuf.StructOrBuilder
    getJsonFormatOrBuilder()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    com.google.protobuf.Parser<FileAccessLog>
    getParserForType()
     
    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()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    com.google.protobuf.StructOrBuilder
    getTypedJsonFormatOrBuilder()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    boolean
    hasFormat()
    Access log :ref:`format string<config_access_log_format_strings>`.
    int
    hashCode()
     
    boolean
    hasJsonFormat()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    boolean
    hasTypedJsonFormat()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FileAccessLog
    parseDelimitedFrom(InputStream input)
     
    static FileAccessLog
    parseDelimitedFrom(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(InputStream input)
     
    static FileAccessLog
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileAccessLog
    parseFrom(ByteBuffer data)
     
    static FileAccessLog
    parseFrom(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, 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

    • PATH_FIELD_NUMBER

      public static final int PATH_FIELD_NUMBER
      See Also:

    • FORMAT_FIELD_NUMBER

      public static final int FORMAT_FIELD_NUMBER
      See Also:

    • JSON_FORMAT_FIELD_NUMBER

      public static final int JSON_FORMAT_FIELD_NUMBER
      See Also:

    • TYPED_JSON_FORMAT_FIELD_NUMBER

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

    • getAccessLogFormatCase

      public FileAccessLog.AccessLogFormatCase getAccessLogFormatCase()
      Specified by:
      getAccessLogFormatCase in interface FileAccessLogOrBuilder

    • getPath

      public 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

      public boolean hasFormat()
       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>`.
      string format = 2;
      Specified by:
      hasFormat in interface FileAccessLogOrBuilder
      Returns:
      Whether the format field is set.

    • getFormat

      public String getFormat()
       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>`.
      string format = 2;
      Specified by:
      getFormat in interface FileAccessLogOrBuilder
      Returns:
      The format.

    • getFormatBytes

      public com.google.protobuf.ByteString getFormatBytes()
       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>`.
      string format = 2;
      Specified by:
      getFormatBytes in interface FileAccessLogOrBuilder
      Returns:
      The bytes for format.

    • hasJsonFormat

      public boolean hasJsonFormat()
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;
      Specified by:
      hasJsonFormat in interface FileAccessLogOrBuilder
      Returns:
      Whether the jsonFormat field is set.

    • getJsonFormat

      public com.google.protobuf.Struct getJsonFormat()
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;
      Specified by:
      getJsonFormat in interface FileAccessLogOrBuilder
      Returns:
      The jsonFormat.

    • getJsonFormatOrBuilder

      public com.google.protobuf.StructOrBuilder getJsonFormatOrBuilder()
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;
      Specified by:
      getJsonFormatOrBuilder in interface FileAccessLogOrBuilder

    • hasTypedJsonFormat

      public boolean hasTypedJsonFormat()
       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.
      .google.protobuf.Struct typed_json_format = 4;
      Specified by:
      hasTypedJsonFormat in interface FileAccessLogOrBuilder
      Returns:
      Whether the typedJsonFormat field is set.

    • getTypedJsonFormat

      public com.google.protobuf.Struct getTypedJsonFormat()
       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.
      .google.protobuf.Struct typed_json_format = 4;
      Specified by:
      getTypedJsonFormat in interface FileAccessLogOrBuilder
      Returns:
      The typedJsonFormat.

    • getTypedJsonFormatOrBuilder

      public com.google.protobuf.StructOrBuilder getTypedJsonFormatOrBuilder()
       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.
      .google.protobuf.Struct typed_json_format = 4;
      Specified by:
      getTypedJsonFormatOrBuilder 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 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 FileAccessLog parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FileAccessLog parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FileAccessLog.Builder newBuilder()

    • newBuilder

      public static FileAccessLog.Builder newBuilder(FileAccessLog prototype)

    • 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