Package io.envoyproxy.envoy.extensions.access_loggers.grpc.v3

Class HttpGrpcAccessLogConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpGrpcAccessLogConfigOrBuilder, Serializable
    public final class HttpGrpcAccessLogConfig
extends com.google.protobuf.GeneratedMessageV3
implements HttpGrpcAccessLogConfigOrBuilder
     Configuration for the built-in ``envoy.access_loggers.http_grpc``
 :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`. This configuration will
 populate :ref:`StreamAccessLogsMessage.http_logs
 <envoy_v3_api_field_service.accesslog.v3.StreamAccessLogsMessage.http_logs>`.
 [#extension: envoy.access_loggers.http_grpc]
    Protobuf type envoy.extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig
    See Also:
    Serialized Form

    • Field Detail

      • COMMON_CONFIG_FIELD_NUMBER

        public static final int COMMON_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_REQUEST_HEADERS_TO_LOG_FIELD_NUMBER

        public static final int ADDITIONAL_REQUEST_HEADERS_TO_LOG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_RESPONSE_HEADERS_TO_LOG_FIELD_NUMBER

        public static final int ADDITIONAL_RESPONSE_HEADERS_TO_LOG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_RESPONSE_TRAILERS_TO_LOG_FIELD_NUMBER

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

      • hasCommonConfig

        public boolean hasCommonConfig()
        .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [(.validate.rules) = { ... }
        Specified by:
        hasCommonConfig in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        Whether the commonConfig field is set.

      • getAdditionalRequestHeadersToLogList

        public com.google.protobuf.ProtocolStringList getAdditionalRequestHeadersToLogList()
         Additional request headers to log in :ref:`HTTPRequestProperties.request_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPRequestProperties.request_headers>`.
        repeated string additional_request_headers_to_log = 2;
        Specified by:
        getAdditionalRequestHeadersToLogList in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        A list containing the additionalRequestHeadersToLog.

      • getAdditionalRequestHeadersToLogCount

        public int getAdditionalRequestHeadersToLogCount()
         Additional request headers to log in :ref:`HTTPRequestProperties.request_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPRequestProperties.request_headers>`.
        repeated string additional_request_headers_to_log = 2;
        Specified by:
        getAdditionalRequestHeadersToLogCount in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        The count of additionalRequestHeadersToLog.

      • getAdditionalRequestHeadersToLog

        public String getAdditionalRequestHeadersToLog​(int index)
         Additional request headers to log in :ref:`HTTPRequestProperties.request_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPRequestProperties.request_headers>`.
        repeated string additional_request_headers_to_log = 2;
        Specified by:
        getAdditionalRequestHeadersToLog in interface HttpGrpcAccessLogConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The additionalRequestHeadersToLog at the given index.

      • getAdditionalRequestHeadersToLogBytes

        public com.google.protobuf.ByteString getAdditionalRequestHeadersToLogBytes​(int index)
         Additional request headers to log in :ref:`HTTPRequestProperties.request_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPRequestProperties.request_headers>`.
        repeated string additional_request_headers_to_log = 2;
        Specified by:
        getAdditionalRequestHeadersToLogBytes in interface HttpGrpcAccessLogConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the additionalRequestHeadersToLog at the given index.

      • getAdditionalResponseHeadersToLogList

        public com.google.protobuf.ProtocolStringList getAdditionalResponseHeadersToLogList()
         Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_headers>`.
        repeated string additional_response_headers_to_log = 3;
        Specified by:
        getAdditionalResponseHeadersToLogList in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        A list containing the additionalResponseHeadersToLog.

      • getAdditionalResponseHeadersToLogCount

        public int getAdditionalResponseHeadersToLogCount()
         Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_headers>`.
        repeated string additional_response_headers_to_log = 3;
        Specified by:
        getAdditionalResponseHeadersToLogCount in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        The count of additionalResponseHeadersToLog.

      • getAdditionalResponseHeadersToLog

        public String getAdditionalResponseHeadersToLog​(int index)
         Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_headers>`.
        repeated string additional_response_headers_to_log = 3;
        Specified by:
        getAdditionalResponseHeadersToLog in interface HttpGrpcAccessLogConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The additionalResponseHeadersToLog at the given index.

      • getAdditionalResponseHeadersToLogBytes

        public com.google.protobuf.ByteString getAdditionalResponseHeadersToLogBytes​(int index)
         Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_headers>`.
        repeated string additional_response_headers_to_log = 3;
        Specified by:
        getAdditionalResponseHeadersToLogBytes in interface HttpGrpcAccessLogConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the additionalResponseHeadersToLog at the given index.

      • getAdditionalResponseTrailersToLogList

        public com.google.protobuf.ProtocolStringList getAdditionalResponseTrailersToLogList()
         Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_trailers>`.
        repeated string additional_response_trailers_to_log = 4;
        Specified by:
        getAdditionalResponseTrailersToLogList in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        A list containing the additionalResponseTrailersToLog.

      • getAdditionalResponseTrailersToLogCount

        public int getAdditionalResponseTrailersToLogCount()
         Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_trailers>`.
        repeated string additional_response_trailers_to_log = 4;
        Specified by:
        getAdditionalResponseTrailersToLogCount in interface HttpGrpcAccessLogConfigOrBuilder
        Returns:
        The count of additionalResponseTrailersToLog.

      • getAdditionalResponseTrailersToLog

        public String getAdditionalResponseTrailersToLog​(int index)
         Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_trailers>`.
        repeated string additional_response_trailers_to_log = 4;
        Specified by:
        getAdditionalResponseTrailersToLog in interface HttpGrpcAccessLogConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The additionalResponseTrailersToLog at the given index.

      • getAdditionalResponseTrailersToLogBytes

        public com.google.protobuf.ByteString getAdditionalResponseTrailersToLogBytes​(int index)
         Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
 <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_trailers>`.
        repeated string additional_response_trailers_to_log = 4;
        Specified by:
        getAdditionalResponseTrailersToLogBytes in interface HttpGrpcAccessLogConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the additionalResponseTrailersToLog at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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