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

Interface FileAccessLogOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FileAccessLog, FileAccessLog.Builder
public interface FileAccessLogOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    FileAccessLog.AccessLogFormatCase
    getAccessLogFormatCase()
     
    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>`.
    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.
    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>`.
    boolean
    hasJsonFormat()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
    boolean
    hasTypedJsonFormat()
    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPath

      String getPath()
       A path to a local file to which to write the access log entries.
      string path = 1 [(.validate.rules) = { ... }
      Returns:
      The path.

    • getPathBytes

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

    • hasFormat

      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;
      Returns:
      Whether the format field is set.

    • getFormat

      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;
      Returns:
      The format.

    • getFormatBytes

      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;
      Returns:
      The bytes for format.

    • hasJsonFormat

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

    • getJsonFormat

      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;
      Returns:
      The jsonFormat.

    • getJsonFormatOrBuilder

      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;

    • hasTypedJsonFormat

      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;
      Returns:
      Whether the typedJsonFormat field is set.

    • getTypedJsonFormat

      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;
      Returns:
      The typedJsonFormat.

    • getTypedJsonFormatOrBuilder

      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;

    • getAccessLogFormatCase

      FileAccessLog.AccessLogFormatCase getAccessLogFormatCase()