io.envoyproxy.envoy.config.accesslog.v2

Class FileAccessLog.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

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 Summary

Modifier and Type	Method and Description
FileAccessLog.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FileAccessLog	build()
FileAccessLog	buildPartial()
FileAccessLog.Builder	clear()
FileAccessLog.Builder	clearAccessLogFormat()
FileAccessLog.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
FileAccessLog.Builder	clearFormat() Access log :ref:`format string<config_access_log_format_strings>`.
FileAccessLog.Builder	clearJsonFormat() Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
FileAccessLog.Builder	clearPath() A path to a local file to which to write the access log entries.
FileAccessLog.Builder	clearTypedJsonFormat() Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	clone()
FileAccessLog.AccessLogFormatCase	getAccessLogFormatCase()
FileAccessLog	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.Struct.Builder	getJsonFormatBuilder() 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.Struct.Builder	getTypedJsonFormatBuilder() 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	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()
boolean	isInitialized()
FileAccessLog.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FileAccessLog.Builder	mergeFrom(FileAccessLog other)
FileAccessLog.Builder	mergeFrom(com.google.protobuf.Message other)
FileAccessLog.Builder	mergeJsonFormat(com.google.protobuf.Struct value) Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	mergeTypedJsonFormat(com.google.protobuf.Struct value) Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FileAccessLog.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FileAccessLog.Builder	setFormat(String value) Access log :ref:`format string<config_access_log_format_strings>`.
FileAccessLog.Builder	setFormatBytes(com.google.protobuf.ByteString value) Access log :ref:`format string<config_access_log_format_strings>`.
FileAccessLog.Builder	setJsonFormat(com.google.protobuf.Struct.Builder builderForValue) Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	setJsonFormat(com.google.protobuf.Struct value) Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	setPath(String value) A path to a local file to which to write the access log entries.
FileAccessLog.Builder	setPathBytes(com.google.protobuf.ByteString value) A path to a local file to which to write the access log entries.
FileAccessLog.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
FileAccessLog.Builder	setTypedJsonFormat(com.google.protobuf.Struct.Builder builderForValue) Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	setTypedJsonFormat(com.google.protobuf.Struct value) Access log :ref:`format dictionary<config_access_log_format_dictionaries>`.
FileAccessLog.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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

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

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

clearPath

public FileAccessLog.Builder clearPath()

 A path to a local file to which to write the access log entries.
 

string path = 1 [(.validate.rules) = { ... }

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

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

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

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;

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;

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;

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

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

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

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

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>