Package io.envoyproxy.envoy.data.accesslog.v2

Class HTTPRequestProperties

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HTTPRequestPropertiesOrBuilder, java.io.Serializable
    public final class HTTPRequestProperties
extends com.google.protobuf.GeneratedMessageV3
implements HTTPRequestPropertiesOrBuilder
     [#next-free-field: 14]
    Protobuf type envoy.data.accesslog.v2.HTTPRequestProperties
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HTTPRequestProperties.Builder
      [#next-free-field: 14]

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsRequestHeaders​(java.lang.String key)
      Map of additional headers that have been configured to be logged.
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAuthority()
      HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
      com.google.protobuf.ByteString getAuthorityBytes()
      HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
      static HTTPRequestProperties getDefaultInstance()  
      HTTPRequestProperties getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getForwardedFor()
      Value of the ``X-Forwarded-For`` request header.
      com.google.protobuf.ByteString getForwardedForBytes()
      Value of the ``X-Forwarded-For`` request header.
      java.lang.String getOriginalPath()
      Value of the ``X-Envoy-Original-Path`` request header.
      com.google.protobuf.ByteString getOriginalPathBytes()
      Value of the ``X-Envoy-Original-Path`` request header.
      com.google.protobuf.Parser<HTTPRequestProperties> getParserForType()  
      java.lang.String getPath()
      The path portion from the incoming request URI.
      com.google.protobuf.ByteString getPathBytes()
      The path portion from the incoming request URI.
      com.google.protobuf.UInt32Value getPort()
      The port of the incoming request URI (unused currently, as port is composed onto authority).
      com.google.protobuf.UInt32ValueOrBuilder getPortOrBuilder()
      The port of the incoming request URI (unused currently, as port is composed onto authority).
      java.lang.String getReferer()
      Value of the ``Referer`` request header.
      com.google.protobuf.ByteString getRefererBytes()
      Value of the ``Referer`` request header.
      long getRequestBodyBytes()
      Size of the HTTP request body in bytes.
      java.util.Map<java.lang.String,​java.lang.String> getRequestHeaders()
      Deprecated.
      long getRequestHeadersBytes()
      Size of the HTTP request headers in bytes.
      int getRequestHeadersCount()
      Map of additional headers that have been configured to be logged.
      java.util.Map<java.lang.String,​java.lang.String> getRequestHeadersMap()
      Map of additional headers that have been configured to be logged.
      java.lang.String getRequestHeadersOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Map of additional headers that have been configured to be logged.
      java.lang.String getRequestHeadersOrThrow​(java.lang.String key)
      Map of additional headers that have been configured to be logged.
      java.lang.String getRequestId()
      Value of the ``X-Request-Id`` request header This header is used by Envoy to uniquely identify a request.
      com.google.protobuf.ByteString getRequestIdBytes()
      Value of the ``X-Request-Id`` request header This header is used by Envoy to uniquely identify a request.
      RequestMethod getRequestMethod()
      The request method (RFC 7231/2616).
      int getRequestMethodValue()
      The request method (RFC 7231/2616).
      java.lang.String getScheme()
      The scheme portion of the incoming request URI.
      com.google.protobuf.ByteString getSchemeBytes()
      The scheme portion of the incoming request URI.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      java.lang.String getUserAgent()
      Value of the ``User-Agent`` request header.
      com.google.protobuf.ByteString getUserAgentBytes()
      Value of the ``User-Agent`` request header.
      int hashCode()  
      boolean hasPort()
      The port of the incoming request URI (unused currently, as port is composed onto authority).
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      boolean isInitialized()  
      static HTTPRequestProperties.Builder newBuilder()  
      static HTTPRequestProperties.Builder newBuilder​(HTTPRequestProperties prototype)  
      HTTPRequestProperties.Builder newBuilderForType()  
      protected HTTPRequestProperties.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static HTTPRequestProperties parseDelimitedFrom​(java.io.InputStream input)  
      static HTTPRequestProperties parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HTTPRequestProperties parseFrom​(byte[] data)  
      static HTTPRequestProperties parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HTTPRequestProperties parseFrom​(com.google.protobuf.ByteString data)  
      static HTTPRequestProperties parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HTTPRequestProperties parseFrom​(com.google.protobuf.CodedInputStream input)  
      static HTTPRequestProperties parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HTTPRequestProperties parseFrom​(java.io.InputStream input)  
      static HTTPRequestProperties parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HTTPRequestProperties parseFrom​(java.nio.ByteBuffer data)  
      static HTTPRequestProperties parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<HTTPRequestProperties> parser()  
      HTTPRequestProperties.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, isStringEmpty, 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • newInstance

        protected java.lang.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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getRequestMethodValue

        public int getRequestMethodValue()
         The request method (RFC 7231/2616).
        .envoy.api.v2.core.RequestMethod request_method = 1 [(.validate.rules) = { ... }
        Specified by:
        getRequestMethodValue in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The enum numeric value on the wire for requestMethod.

      • getScheme

        public java.lang.String getScheme()
         The scheme portion of the incoming request URI.
        string scheme = 2;
        Specified by:
        getScheme in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The scheme.

      • getSchemeBytes

        public com.google.protobuf.ByteString getSchemeBytes()
         The scheme portion of the incoming request URI.
        string scheme = 2;
        Specified by:
        getSchemeBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for scheme.

      • getAuthority

        public java.lang.String getAuthority()
         HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
        string authority = 3;
        Specified by:
        getAuthority in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The authority.

      • getAuthorityBytes

        public com.google.protobuf.ByteString getAuthorityBytes()
         HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
        string authority = 3;
        Specified by:
        getAuthorityBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for authority.

      • hasPort

        public boolean hasPort()
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;
        Specified by:
        hasPort in interface HTTPRequestPropertiesOrBuilder
        Returns:
        Whether the port field is set.

      • getPort

        public com.google.protobuf.UInt32Value getPort()
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;
        Specified by:
        getPort in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The port.

      • getPortOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getPortOrBuilder()
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;
        Specified by:
        getPortOrBuilder in interface HTTPRequestPropertiesOrBuilder

      • getPath

        public java.lang.String getPath()
         The path portion from the incoming request URI.
        string path = 5;
        Specified by:
        getPath in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The path.

      • getPathBytes

        public com.google.protobuf.ByteString getPathBytes()
         The path portion from the incoming request URI.
        string path = 5;
        Specified by:
        getPathBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for path.

      • getUserAgent

        public java.lang.String getUserAgent()
         Value of the ``User-Agent`` request header.
        string user_agent = 6;
        Specified by:
        getUserAgent in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The userAgent.

      • getUserAgentBytes

        public com.google.protobuf.ByteString getUserAgentBytes()
         Value of the ``User-Agent`` request header.
        string user_agent = 6;
        Specified by:
        getUserAgentBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for userAgent.

      • getReferer

        public java.lang.String getReferer()
         Value of the ``Referer`` request header.
        string referer = 7;
        Specified by:
        getReferer in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The referer.

      • getRefererBytes

        public com.google.protobuf.ByteString getRefererBytes()
         Value of the ``Referer`` request header.
        string referer = 7;
        Specified by:
        getRefererBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for referer.

      • getForwardedFor

        public java.lang.String getForwardedFor()
         Value of the ``X-Forwarded-For`` request header.
        string forwarded_for = 8;
        Specified by:
        getForwardedFor in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The forwardedFor.

      • getForwardedForBytes

        public com.google.protobuf.ByteString getForwardedForBytes()
         Value of the ``X-Forwarded-For`` request header.
        string forwarded_for = 8;
        Specified by:
        getForwardedForBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for forwardedFor.

      • getRequestId

        public java.lang.String getRequestId()
         Value of the ``X-Request-Id`` request header
 This header is used by Envoy to uniquely identify a request.
 It will be generated for all external requests and internal requests that
 do not already have a request ID.
        string request_id = 9;
        Specified by:
        getRequestId in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The requestId.

      • getRequestIdBytes

        public com.google.protobuf.ByteString getRequestIdBytes()
         Value of the ``X-Request-Id`` request header
 This header is used by Envoy to uniquely identify a request.
 It will be generated for all external requests and internal requests that
 do not already have a request ID.
        string request_id = 9;
        Specified by:
        getRequestIdBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for requestId.

      • getOriginalPath

        public java.lang.String getOriginalPath()
         Value of the ``X-Envoy-Original-Path`` request header.
        string original_path = 10;
        Specified by:
        getOriginalPath in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The originalPath.

      • getOriginalPathBytes

        public com.google.protobuf.ByteString getOriginalPathBytes()
         Value of the ``X-Envoy-Original-Path`` request header.
        string original_path = 10;
        Specified by:
        getOriginalPathBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for originalPath.

      • getRequestHeadersBytes

        public long getRequestHeadersBytes()
         Size of the HTTP request headers in bytes.
 This value is captured from the OSI layer 7 perspective, i.e. it does not
 include overhead from framing or encoding at other networking layers.
        uint64 request_headers_bytes = 11;
        Specified by:
        getRequestHeadersBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The requestHeadersBytes.

      • getRequestBodyBytes

        public long getRequestBodyBytes()
         Size of the HTTP request body in bytes.
 This value is captured from the OSI layer 7 perspective, i.e. it does not
 include overhead from framing or encoding at other networking layers.
        uint64 request_body_bytes = 12;
        Specified by:
        getRequestBodyBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The requestBodyBytes.

      • containsRequestHeaders

        public boolean containsRequestHeaders​(java.lang.String key)
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;
        Specified by:
        containsRequestHeaders in interface HTTPRequestPropertiesOrBuilder

      • getRequestHeadersMap

        public java.util.Map<java.lang.String,​java.lang.String> getRequestHeadersMap()
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;
        Specified by:
        getRequestHeadersMap in interface HTTPRequestPropertiesOrBuilder

      • getRequestHeadersOrDefault

        public java.lang.String getRequestHeadersOrDefault​(java.lang.String key,
                                                   java.lang.String defaultValue)
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;
        Specified by:
        getRequestHeadersOrDefault in interface HTTPRequestPropertiesOrBuilder

      • getRequestHeadersOrThrow

        public java.lang.String getRequestHeadersOrThrow​(java.lang.String key)
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;
        Specified by:
        getRequestHeadersOrThrow in interface HTTPRequestPropertiesOrBuilder

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 HTTPRequestProperties parseFrom​(java.nio.ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static HTTPRequestProperties parseFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static HTTPRequestProperties parseFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static HTTPRequestProperties parseDelimitedFrom​(java.io.InputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static HTTPRequestProperties parseDelimitedFrom​(java.io.InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static HTTPRequestProperties parseFrom​(com.google.protobuf.CodedInputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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