io.envoyproxy.envoy.extensions.access_loggers.grpc.v4alpha

Class CommonGrpcAccessLogConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.access_loggers.grpc.v4alpha.CommonGrpcAccessLogConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommonGrpcAccessLogConfigOrBuilder, Serializable

public final class CommonGrpcAccessLogConfig
extends com.google.protobuf.GeneratedMessageV3
implements CommonGrpcAccessLogConfigOrBuilder

 Common configuration for gRPC access logs.
 [#next-free-field: 7]
 

Protobuf type envoy.extensions.access_loggers.grpc.v4alpha.CommonGrpcAccessLogConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonGrpcAccessLogConfig.Builder Common configuration for gRPC access logs.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_FLUSH_INTERVAL_FIELD_NUMBER
static int	BUFFER_SIZE_BYTES_FIELD_NUMBER
static int	FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER
static int	GRPC_SERVICE_FIELD_NUMBER
static int	LOG_NAME_FIELD_NUMBER
static int	TRANSPORT_API_VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
com.google.protobuf.Duration	getBufferFlushInterval() Interval for flushing access logs to the gRPC stream.
com.google.protobuf.DurationOrBuilder	getBufferFlushIntervalOrBuilder() Interval for flushing access logs to the gRPC stream.
com.google.protobuf.UInt32Value	getBufferSizeBytes() Soft size limit in bytes for access log entries buffer.
com.google.protobuf.UInt32ValueOrBuilder	getBufferSizeBytesOrBuilder() Soft size limit in bytes for access log entries buffer.
static CommonGrpcAccessLogConfig	getDefaultInstance()
CommonGrpcAccessLogConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilterStateObjectsToLog(int index) Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
com.google.protobuf.ByteString	getFilterStateObjectsToLogBytes(int index) Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
int	getFilterStateObjectsToLogCount() Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
com.google.protobuf.ProtocolStringList	getFilterStateObjectsToLogList() Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
GrpcService	getGrpcService() The gRPC service for the access log service.
GrpcServiceOrBuilder	getGrpcServiceOrBuilder() The gRPC service for the access log service.
String	getLogName() The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier <envoy_api_msg_service.accesslog.v4alpha.StreamAccessLogsMessage.Identifier>`.
com.google.protobuf.ByteString	getLogNameBytes() The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier <envoy_api_msg_service.accesslog.v4alpha.StreamAccessLogsMessage.Identifier>`.
com.google.protobuf.Parser<CommonGrpcAccessLogConfig>	getParserForType()
int	getSerializedSize()
ApiVersion	getTransportApiVersion() API version for access logs service transport protocol.
int	getTransportApiVersionValue() API version for access logs service transport protocol.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBufferFlushInterval() Interval for flushing access logs to the gRPC stream.
boolean	hasBufferSizeBytes() Soft size limit in bytes for access log entries buffer.
boolean	hasGrpcService() The gRPC service for the access log service.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CommonGrpcAccessLogConfig.Builder	newBuilder()
static CommonGrpcAccessLogConfig.Builder	newBuilder(CommonGrpcAccessLogConfig prototype)
CommonGrpcAccessLogConfig.Builder	newBuilderForType()
protected CommonGrpcAccessLogConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CommonGrpcAccessLogConfig	parseDelimitedFrom(InputStream input)
static CommonGrpcAccessLogConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonGrpcAccessLogConfig	parseFrom(byte[] data)
static CommonGrpcAccessLogConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonGrpcAccessLogConfig	parseFrom(ByteBuffer data)
static CommonGrpcAccessLogConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonGrpcAccessLogConfig	parseFrom(com.google.protobuf.ByteString data)
static CommonGrpcAccessLogConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonGrpcAccessLogConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static CommonGrpcAccessLogConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonGrpcAccessLogConfig	parseFrom(InputStream input)
static CommonGrpcAccessLogConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CommonGrpcAccessLogConfig>	parser()
CommonGrpcAccessLogConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

LOG_NAME_FIELD_NUMBER

public static final int LOG_NAME_FIELD_NUMBER

See Also:

Constant Field Values

GRPC_SERVICE_FIELD_NUMBER

public static final int GRPC_SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

TRANSPORT_API_VERSION_FIELD_NUMBER

public static final int TRANSPORT_API_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

BUFFER_FLUSH_INTERVAL_FIELD_NUMBER

public static final int BUFFER_FLUSH_INTERVAL_FIELD_NUMBER

See Also:

Constant Field Values

BUFFER_SIZE_BYTES_FIELD_NUMBER

public static final int BUFFER_SIZE_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER

public static final int FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getLogName

public String getLogName()

 The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
 <envoy_api_msg_service.accesslog.v4alpha.StreamAccessLogsMessage.Identifier>`. This allows the
 access log server to differentiate between different access logs coming from the same Envoy.
 

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

Specified by:

getLogName in interface CommonGrpcAccessLogConfigOrBuilder

getLogNameBytes

public com.google.protobuf.ByteString getLogNameBytes()

 The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
 <envoy_api_msg_service.accesslog.v4alpha.StreamAccessLogsMessage.Identifier>`. This allows the
 access log server to differentiate between different access logs coming from the same Envoy.
 

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

Specified by:

getLogNameBytes in interface CommonGrpcAccessLogConfigOrBuilder

hasGrpcService

public boolean hasGrpcService()

 The gRPC service for the access log service.
 

.envoy.config.core.v4alpha.GrpcService grpc_service = 2 [(.validate.rules) = { ... }

Specified by:

hasGrpcService in interface CommonGrpcAccessLogConfigOrBuilder

getGrpcService

public GrpcService getGrpcService()

 The gRPC service for the access log service.
 

.envoy.config.core.v4alpha.GrpcService grpc_service = 2 [(.validate.rules) = { ... }

Specified by:

getGrpcService in interface CommonGrpcAccessLogConfigOrBuilder

getGrpcServiceOrBuilder

public GrpcServiceOrBuilder getGrpcServiceOrBuilder()

 The gRPC service for the access log service.
 

.envoy.config.core.v4alpha.GrpcService grpc_service = 2 [(.validate.rules) = { ... }

Specified by:

getGrpcServiceOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

getTransportApiVersionValue

public int getTransportApiVersionValue()

 API version for access logs service transport protocol. This describes the access logs service
 gRPC endpoint and version of messages used on the wire.
 

.envoy.config.core.v4alpha.ApiVersion transport_api_version = 6 [(.validate.rules) = { ... }

Specified by:

getTransportApiVersionValue in interface CommonGrpcAccessLogConfigOrBuilder

getTransportApiVersion

public ApiVersion getTransportApiVersion()

 API version for access logs service transport protocol. This describes the access logs service
 gRPC endpoint and version of messages used on the wire.
 

.envoy.config.core.v4alpha.ApiVersion transport_api_version = 6 [(.validate.rules) = { ... }

Specified by:

getTransportApiVersion in interface CommonGrpcAccessLogConfigOrBuilder

hasBufferFlushInterval

public boolean hasBufferFlushInterval()

 Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
 this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
 1 second.
 

.google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }

Specified by:

hasBufferFlushInterval in interface CommonGrpcAccessLogConfigOrBuilder

getBufferFlushInterval

public com.google.protobuf.Duration getBufferFlushInterval()

 Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
 this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
 1 second.
 

.google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }

Specified by:

getBufferFlushInterval in interface CommonGrpcAccessLogConfigOrBuilder

getBufferFlushIntervalOrBuilder

public com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()

 Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
 this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
 1 second.
 

.google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }

Specified by:

getBufferFlushIntervalOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

hasBufferSizeBytes

public boolean hasBufferSizeBytes()

 Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
 to zero effectively disables the batching. Defaults to 16384.
 

.google.protobuf.UInt32Value buffer_size_bytes = 4;

Specified by:

hasBufferSizeBytes in interface CommonGrpcAccessLogConfigOrBuilder

getBufferSizeBytes

public com.google.protobuf.UInt32Value getBufferSizeBytes()

 Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
 to zero effectively disables the batching. Defaults to 16384.
 

.google.protobuf.UInt32Value buffer_size_bytes = 4;

Specified by:

getBufferSizeBytes in interface CommonGrpcAccessLogConfigOrBuilder

getBufferSizeBytesOrBuilder

public com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()

 Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
 to zero effectively disables the batching. Defaults to 16384.
 

.google.protobuf.UInt32Value buffer_size_bytes = 4;

Specified by:

getBufferSizeBytesOrBuilder in interface CommonGrpcAccessLogConfigOrBuilder

getFilterStateObjectsToLogList

public com.google.protobuf.ProtocolStringList getFilterStateObjectsToLogList()

 Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
 

repeated string filter_state_objects_to_log = 5;

Specified by:

getFilterStateObjectsToLogList in interface CommonGrpcAccessLogConfigOrBuilder

getFilterStateObjectsToLogCount

public int getFilterStateObjectsToLogCount()

 Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
 

repeated string filter_state_objects_to_log = 5;

Specified by:

getFilterStateObjectsToLogCount in interface CommonGrpcAccessLogConfigOrBuilder

getFilterStateObjectsToLog

public String getFilterStateObjectsToLog(int index)

 Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
 

repeated string filter_state_objects_to_log = 5;

Specified by:

getFilterStateObjectsToLog in interface CommonGrpcAccessLogConfigOrBuilder

getFilterStateObjectsToLogBytes

public com.google.protobuf.ByteString getFilterStateObjectsToLogBytes(int index)

 Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
 

repeated string filter_state_objects_to_log = 5;

Specified by:

getFilterStateObjectsToLogBytes in interface CommonGrpcAccessLogConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static CommonGrpcAccessLogConfig parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static CommonGrpcAccessLogConfig parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static CommonGrpcAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public CommonGrpcAccessLogConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CommonGrpcAccessLogConfig.Builder newBuilder()

newBuilder

public static CommonGrpcAccessLogConfig.Builder newBuilder(CommonGrpcAccessLogConfig prototype)

toBuilder

public CommonGrpcAccessLogConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CommonGrpcAccessLogConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CommonGrpcAccessLogConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<CommonGrpcAccessLogConfig> parser()

getParserForType

public com.google.protobuf.Parser<CommonGrpcAccessLogConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CommonGrpcAccessLogConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder