Class FileAccessLog
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.access_loggers.file.v3.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_v3_api_msg_config.accesslog.v3.AccessLog>` that writes log entries directly to a file. Configures the built-in ``envoy.access_loggers.file`` AccessLog. [#next-free-field: 6]Protobuf type
envoy.extensions.access_loggers.file.v3.FileAccessLog- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic final classCustom configuration for an :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic FileAccessLogstatic final com.google.protobuf.Descriptors.DescriptorDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.com.google.protobuf.ByteStringDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.com.google.protobuf.StructDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated.com.google.protobuf.StructOrBuilderDeprecated.Configuration to form access log data and format.Configuration to form access log data and format.com.google.protobuf.Parser<FileAccessLog>getPath()A path to a local file to which to write the access log entries.com.google.protobuf.ByteStringA path to a local file to which to write the access log entries.intcom.google.protobuf.StructDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated.com.google.protobuf.StructOrBuilderDeprecated.booleanDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated.inthashCode()booleanDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated.booleanConfiguration to form access log data and format.booleanDeprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic FileAccessLog.Builderstatic FileAccessLog.BuildernewBuilder(FileAccessLog prototype) protected FileAccessLog.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static FileAccessLogparseDelimitedFrom(InputStream input) static FileAccessLogparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FileAccessLogparseFrom(byte[] data) static FileAccessLogparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FileAccessLogparseFrom(com.google.protobuf.ByteString data) static FileAccessLogparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FileAccessLogparseFrom(com.google.protobuf.CodedInputStream input) static FileAccessLogparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FileAccessLogparseFrom(InputStream input) static FileAccessLogparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FileAccessLogparseFrom(ByteBuffer data) static FileAccessLogparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<FileAccessLog>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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:
-
LOG_FORMAT_FIELD_NUMBER
public static final int LOG_FORMAT_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getAccessLogFormatCase
- Specified by:
getAccessLogFormatCasein interfaceFileAccessLogOrBuilder
-
getPath
A path to a local file to which to write the access log entries.
string path = 1 [(.validate.rules) = { ... }- Specified by:
getPathin interfaceFileAccessLogOrBuilder- 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:
getPathBytesin interfaceFileAccessLogOrBuilder- Returns:
- The bytes for path.
-
hasFormat
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=39Access 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"];- Specified by:
hasFormatin interfaceFileAccessLogOrBuilder- Returns:
- Whether the format field is set.
-
getFormat
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=39Access 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"];- Specified by:
getFormatin interfaceFileAccessLogOrBuilder- Returns:
- The format.
-
getFormatBytes
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=39Access 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"];- Specified by:
getFormatBytesin interfaceFileAccessLogOrBuilder- Returns:
- The bytes for format.
-
hasJsonFormat
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=45Access 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"];- Specified by:
hasJsonFormatin interfaceFileAccessLogOrBuilder- Returns:
- Whether the jsonFormat field is set.
-
getJsonFormat
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=45Access 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"];- Specified by:
getJsonFormatin interfaceFileAccessLogOrBuilder- Returns:
- The jsonFormat.
-
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"];- Specified by:
getJsonFormatOrBuilderin interfaceFileAccessLogOrBuilder
-
hasTypedJsonFormat
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=54Access 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"];- Specified by:
hasTypedJsonFormatin interfaceFileAccessLogOrBuilder- Returns:
- Whether the typedJsonFormat field is set.
-
getTypedJsonFormat
Deprecated.envoy.extensions.access_loggers.file.v3.FileAccessLog.typed_json_format is deprecated. See envoy/extensions/access_loggers/file/v3/file.proto;l=54Access 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"];- Specified by:
getTypedJsonFormatin interfaceFileAccessLogOrBuilder- Returns:
- The typedJsonFormat.
-
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"];- Specified by:
getTypedJsonFormatOrBuilderin interfaceFileAccessLogOrBuilder
-
hasLogFormat
public 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) = { ... }- Specified by:
hasLogFormatin interfaceFileAccessLogOrBuilder- Returns:
- Whether the logFormat field is set.
-
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) = { ... }- Specified by:
getLogFormatin interfaceFileAccessLogOrBuilder- Returns:
- The logFormat.
-
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) = { ... }- Specified by:
getLogFormatOrBuilderin interfaceFileAccessLogOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static FileAccessLog parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FileAccessLog.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-