io.envoyproxy.envoy.config.filter.http.grpc_stats.v2alpha

Class FilterConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.filter.http.grpc_stats.v2alpha.FilterConfig

All Implemented Interfaces:

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

public final class FilterConfig
extends com.google.protobuf.GeneratedMessageV3
implements FilterConfigOrBuilder

 gRPC statistics filter configuration
 

Protobuf type envoy.config.filter.http.grpc_stats.v2alpha.FilterConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterConfig.Builder gRPC statistics filter configuration Protobuf type envoy.config.filter.http.grpc_stats.v2alpha.FilterConfig
static class	FilterConfig.PerMethodStatSpecifierCase

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	EMIT_FILTER_STATE_FIELD_NUMBER
static int	INDIVIDUAL_METHOD_STATS_ALLOWLIST_FIELD_NUMBER
static int	STATS_FOR_ALL_METHODS_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)
static FilterConfig	getDefaultInstance()
FilterConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEmitFilterState() If true, the filter maintains a filter state object with the request and response message counts.
GrpcMethodList	getIndividualMethodStatsAllowlist() If set, specifies an allowlist of service/methods that will have individual stats emitted for them.
GrpcMethodListOrBuilder	getIndividualMethodStatsAllowlistOrBuilder() If set, specifies an allowlist of service/methods that will have individual stats emitted for them.
com.google.protobuf.Parser<FilterConfig>	getParserForType()
FilterConfig.PerMethodStatSpecifierCase	getPerMethodStatSpecifierCase()
int	getSerializedSize()
com.google.protobuf.BoolValue	getStatsForAllMethods() If set to true, emit stats for all service/method names.
com.google.protobuf.BoolValueOrBuilder	getStatsForAllMethodsOrBuilder() If set to true, emit stats for all service/method names.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasIndividualMethodStatsAllowlist() If set, specifies an allowlist of service/methods that will have individual stats emitted for them.
boolean	hasStatsForAllMethods() If set to true, emit stats for all service/method names.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FilterConfig.Builder	newBuilder()
static FilterConfig.Builder	newBuilder(FilterConfig prototype)
FilterConfig.Builder	newBuilderForType()
protected FilterConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FilterConfig	parseDelimitedFrom(InputStream input)
static FilterConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterConfig	parseFrom(byte[] data)
static FilterConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterConfig	parseFrom(ByteBuffer data)
static FilterConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterConfig	parseFrom(com.google.protobuf.ByteString data)
static FilterConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static FilterConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterConfig	parseFrom(InputStream input)
static FilterConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FilterConfig>	parser()
FilterConfig.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

EMIT_FILTER_STATE_FIELD_NUMBER

public static final int EMIT_FILTER_STATE_FIELD_NUMBER

See Also:

Constant Field Values

INDIVIDUAL_METHOD_STATS_ALLOWLIST_FIELD_NUMBER

public static final int INDIVIDUAL_METHOD_STATS_ALLOWLIST_FIELD_NUMBER

See Also:

Constant Field Values

STATS_FOR_ALL_METHODS_FIELD_NUMBER

public static final int STATS_FOR_ALL_METHODS_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

getPerMethodStatSpecifierCase

public FilterConfig.PerMethodStatSpecifierCase getPerMethodStatSpecifierCase()

Specified by:

getPerMethodStatSpecifierCase in interface FilterConfigOrBuilder

getEmitFilterState

public boolean getEmitFilterState()

 If true, the filter maintains a filter state object with the request and response message
 counts.
 

bool emit_filter_state = 1;

Specified by:

getEmitFilterState in interface FilterConfigOrBuilder

hasIndividualMethodStatsAllowlist

public boolean hasIndividualMethodStatsAllowlist()

 If set, specifies an allowlist of service/methods that will have individual stats
 emitted for them. Any call that does not match the allowlist will be counted
 in a stat with no method specifier: `cluster.<name>.grpc.*`.
 

.envoy.api.v2.core.GrpcMethodList individual_method_stats_allowlist = 2;

Specified by:

hasIndividualMethodStatsAllowlist in interface FilterConfigOrBuilder

getIndividualMethodStatsAllowlist

public GrpcMethodList getIndividualMethodStatsAllowlist()

 If set, specifies an allowlist of service/methods that will have individual stats
 emitted for them. Any call that does not match the allowlist will be counted
 in a stat with no method specifier: `cluster.<name>.grpc.*`.
 

.envoy.api.v2.core.GrpcMethodList individual_method_stats_allowlist = 2;

Specified by:

getIndividualMethodStatsAllowlist in interface FilterConfigOrBuilder

getIndividualMethodStatsAllowlistOrBuilder

public GrpcMethodListOrBuilder getIndividualMethodStatsAllowlistOrBuilder()

 If set, specifies an allowlist of service/methods that will have individual stats
 emitted for them. Any call that does not match the allowlist will be counted
 in a stat with no method specifier: `cluster.<name>.grpc.*`.
 

.envoy.api.v2.core.GrpcMethodList individual_method_stats_allowlist = 2;

Specified by:

getIndividualMethodStatsAllowlistOrBuilder in interface FilterConfigOrBuilder

hasStatsForAllMethods

public boolean hasStatsForAllMethods()

 If set to true, emit stats for all service/method names.
 If set to false, emit stats for all service/message types to the same stats without including
 the service/method in the name, with prefix `cluster.<name>.grpc`. This can be useful if
 service/method granularity is not needed, or if each cluster only receives a single method.
 .. attention::
   This option is only safe if all clients are trusted. If this option is enabled
   with untrusted clients, the clients could cause unbounded growth in the number of stats in
   Envoy, using unbounded memory and potentially slowing down stats pipelines.
 .. attention::
   If neither `individual_method_stats_allowlist` nor `stats_for_all_methods` is set, the
   behavior will default to `stats_for_all_methods=true`. This default value is deprecated,
   and in a future release, if neither field is set, it will default to
   `stats_for_all_methods=false` in order to be safe by default. This behavior can be
   controlled with runtime override
   `envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default`.
 

.google.protobuf.BoolValue stats_for_all_methods = 3;

Specified by:

hasStatsForAllMethods in interface FilterConfigOrBuilder

getStatsForAllMethods

public com.google.protobuf.BoolValue getStatsForAllMethods()

 If set to true, emit stats for all service/method names.
 If set to false, emit stats for all service/message types to the same stats without including
 the service/method in the name, with prefix `cluster.<name>.grpc`. This can be useful if
 service/method granularity is not needed, or if each cluster only receives a single method.
 .. attention::
   This option is only safe if all clients are trusted. If this option is enabled
   with untrusted clients, the clients could cause unbounded growth in the number of stats in
   Envoy, using unbounded memory and potentially slowing down stats pipelines.
 .. attention::
   If neither `individual_method_stats_allowlist` nor `stats_for_all_methods` is set, the
   behavior will default to `stats_for_all_methods=true`. This default value is deprecated,
   and in a future release, if neither field is set, it will default to
   `stats_for_all_methods=false` in order to be safe by default. This behavior can be
   controlled with runtime override
   `envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default`.
 

.google.protobuf.BoolValue stats_for_all_methods = 3;

Specified by:

getStatsForAllMethods in interface FilterConfigOrBuilder

getStatsForAllMethodsOrBuilder

public com.google.protobuf.BoolValueOrBuilder getStatsForAllMethodsOrBuilder()

 If set to true, emit stats for all service/method names.
 If set to false, emit stats for all service/message types to the same stats without including
 the service/method in the name, with prefix `cluster.<name>.grpc`. This can be useful if
 service/method granularity is not needed, or if each cluster only receives a single method.
 .. attention::
   This option is only safe if all clients are trusted. If this option is enabled
   with untrusted clients, the clients could cause unbounded growth in the number of stats in
   Envoy, using unbounded memory and potentially slowing down stats pipelines.
 .. attention::
   If neither `individual_method_stats_allowlist` nor `stats_for_all_methods` is set, the
   behavior will default to `stats_for_all_methods=true`. This default value is deprecated,
   and in a future release, if neither field is set, it will default to
   `stats_for_all_methods=false` in order to be safe by default. This behavior can be
   controlled with runtime override
   `envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default`.
 

.google.protobuf.BoolValue stats_for_all_methods = 3;

Specified by:

getStatsForAllMethodsOrBuilder in interface FilterConfigOrBuilder

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 FilterConfig parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FilterConfig parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FilterConfig parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FilterConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FilterConfig.Builder newBuilder()

newBuilder

public static FilterConfig.Builder newBuilder(FilterConfig prototype)

toBuilder

public FilterConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FilterConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FilterConfig> 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 FilterConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder