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

Class GrpcStatusFilter

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GrpcStatusFilterOrBuilder, Serializable
    public final class GrpcStatusFilter
extends com.google.protobuf.GeneratedMessageV3
implements GrpcStatusFilterOrBuilder
     Filters gRPC requests based on their response status. If a gRPC status is not provided, the
 filter will infer the status from the HTTP status code.
    Protobuf type envoy.config.filter.accesslog.v2.GrpcStatusFilter
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GrpcStatusFilter.Builder
      Filters gRPC requests based on their response status.
      static class  GrpcStatusFilter.Status
      Protobuf enum envoy.config.filter.accesslog.v2.GrpcStatusFilter.Status

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int EXCLUDE_FIELD_NUMBER  
      static int STATUSES_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 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

      • getStatusesList

        public List<GrpcStatusFilter.Status> getStatusesList()
         Logs only responses that have any one of the gRPC statuses in this field.
        repeated .envoy.config.filter.accesslog.v2.GrpcStatusFilter.Status statuses = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatusesList in interface GrpcStatusFilterOrBuilder
        Returns:
        A list containing the statuses.

      • getStatusesCount

        public int getStatusesCount()
         Logs only responses that have any one of the gRPC statuses in this field.
        repeated .envoy.config.filter.accesslog.v2.GrpcStatusFilter.Status statuses = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatusesCount in interface GrpcStatusFilterOrBuilder
        Returns:
        The count of statuses.

      • getStatuses

        public GrpcStatusFilter.Status getStatuses​(int index)
         Logs only responses that have any one of the gRPC statuses in this field.
        repeated .envoy.config.filter.accesslog.v2.GrpcStatusFilter.Status statuses = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatuses in interface GrpcStatusFilterOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The statuses at the given index.

      • getStatusesValueList

        public List<Integer> getStatusesValueList()
         Logs only responses that have any one of the gRPC statuses in this field.
        repeated .envoy.config.filter.accesslog.v2.GrpcStatusFilter.Status statuses = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatusesValueList in interface GrpcStatusFilterOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for statuses.

      • getStatusesValue

        public int getStatusesValue​(int index)
         Logs only responses that have any one of the gRPC statuses in this field.
        repeated .envoy.config.filter.accesslog.v2.GrpcStatusFilter.Status statuses = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatusesValue in interface GrpcStatusFilterOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of statuses at the given index.

      • getExclude

        public boolean getExclude()
         If included and set to true, the filter will instead block all responses with a gRPC status or
 inferred gRPC status enumerated in statuses, and allow all other responses.
        bool exclude = 2;
        Specified by:
        getExclude in interface GrpcStatusFilterOrBuilder
        Returns:
        The exclude.

      • 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 GrpcStatusFilter parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GrpcStatusFilter parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GrpcStatusFilter parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GrpcStatusFilter parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GrpcStatusFilter parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GrpcStatusFilter parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GrpcStatusFilter parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public GrpcStatusFilter.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public GrpcStatusFilter.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected GrpcStatusFilter.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<GrpcStatusFilter> 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 GrpcStatusFilter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder