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

Class FileAccessLog.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>
io.envoyproxy.envoy.config.accesslog.v2.FileAccessLog.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FileAccessLogOrBuilder, Cloneable
Enclosing class:
FileAccessLog
public static final class FileAccessLog.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder> 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

  • Method Details

    • 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.Builder<FileAccessLog.Builder>

    • clear

      public FileAccessLog.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • getDefaultInstanceForType

      public FileAccessLog getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public FileAccessLog.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • setField

      public FileAccessLog.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • clearField

      public FileAccessLog.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • clearOneof

      public FileAccessLog.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • setRepeatedField

      public FileAccessLog.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • addRepeatedField

      public FileAccessLog.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • mergeFrom

      public FileAccessLog.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FileAccessLog.Builder>

    • mergeFrom

      public FileAccessLog.Builder mergeFrom(FileAccessLog other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • mergeFrom

      public FileAccessLog.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FileAccessLog.Builder>
      Throws:
      IOException

    • getAccessLogFormatCase

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

    • clearAccessLogFormat

      public FileAccessLog.Builder clearAccessLogFormat()

    • 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.

    • setPath

      public FileAccessLog.Builder setPath(String value)
       A path to a local file to which to write the access log entries.
      string path = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The path to set.
      Returns:
      This builder for chaining.

    • clearPath

      public FileAccessLog.Builder clearPath()
       A path to a local file to which to write the access log entries.
      string path = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setPathBytes

      public FileAccessLog.Builder setPathBytes(com.google.protobuf.ByteString value)
       A path to a local file to which to write the access log entries.
      string path = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for path to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFormat

      public FileAccessLog.Builder setFormat(String value)
       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;
      Parameters:
      value - The format to set.
      Returns:
      This builder for chaining.

    • clearFormat

      public FileAccessLog.Builder clearFormat()
       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:
      This builder for chaining.

    • setFormatBytes

      public FileAccessLog.Builder setFormatBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for format to set.
      Returns:
      This builder for chaining.

    • 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.

    • setJsonFormat

      public FileAccessLog.Builder setJsonFormat(com.google.protobuf.Struct value)
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;

    • setJsonFormat

      public FileAccessLog.Builder setJsonFormat(com.google.protobuf.Struct.Builder builderForValue)
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;

    • mergeJsonFormat

      public FileAccessLog.Builder mergeJsonFormat(com.google.protobuf.Struct value)
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;

    • clearJsonFormat

      public FileAccessLog.Builder clearJsonFormat()
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;

    • getJsonFormatBuilder

      public com.google.protobuf.Struct.Builder getJsonFormatBuilder()
       Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
 are rendered as strings.
      .google.protobuf.Struct json_format = 3;

    • 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.

    • setTypedJsonFormat

      public FileAccessLog.Builder setTypedJsonFormat(com.google.protobuf.Struct value)
       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;

    • setTypedJsonFormat

      public FileAccessLog.Builder setTypedJsonFormat(com.google.protobuf.Struct.Builder builderForValue)
       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;

    • mergeTypedJsonFormat

      public FileAccessLog.Builder mergeTypedJsonFormat(com.google.protobuf.Struct value)
       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;

    • clearTypedJsonFormat

      public FileAccessLog.Builder clearTypedJsonFormat()
       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;

    • getTypedJsonFormatBuilder

      public com.google.protobuf.Struct.Builder getTypedJsonFormatBuilder()
       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;

    • 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

    • setUnknownFields

      public final FileAccessLog.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>

    • mergeUnknownFields

      public final FileAccessLog.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FileAccessLog.Builder>