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

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()
    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.
    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()
    Deprecated.
    envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated.
    com.google.protobuf.StructOrBuilder
    getTypedJsonFormatOrBuilder()
    Deprecated.
    boolean
    hasFormat()
    Deprecated.
    envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.
    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.

    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

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

    • getFormat

      @Deprecated 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"];
      Returns:
      The format.

    • getFormatBytes

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

    • hasJsonFormat

      @Deprecated 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"];
      Returns:
      Whether the jsonFormat field is set.

    • getJsonFormat

      @Deprecated 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"];
      Returns:
      The jsonFormat.

    • getJsonFormatOrBuilder

      @Deprecated 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"];

    • hasTypedJsonFormat

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

    • getTypedJsonFormat

      @Deprecated 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"];
      Returns:
      The typedJsonFormat.

    • getTypedJsonFormatOrBuilder

      @Deprecated 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"];

    • hasLogFormat

      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) = { ... }
      Returns:
      Whether the logFormat field is set.

    • getLogFormat

      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) = { ... }
      Returns:
      The logFormat.

    • getLogFormatOrBuilder

      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) = { ... }

    • getAccessLogFormatCase

      FileAccessLog.AccessLogFormatCase getAccessLogFormatCase()