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

Interface HTTPRequestPropertiesOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HTTPRequestProperties, HTTPRequestProperties.Builder
    public interface HTTPRequestPropertiesOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract 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.
      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.
      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.
      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.
      java.lang.String getUserAgent()
      Value of the ``User-Agent`` request header.
      com.google.protobuf.ByteString getUserAgentBytes()
      Value of the ``User-Agent`` request header.
      boolean hasPort()
      The port of the incoming request URI (unused currently, as port is composed onto authority).

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

        isInitialized

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

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

    • Method Detail

      • getRequestMethodValue

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

      • getRequestMethod

        RequestMethod getRequestMethod()
         The request method (RFC 7231/2616).
        .envoy.api.v2.core.RequestMethod request_method = 1 [(.validate.rules) = { ... }
        Returns:
        The requestMethod.

      • getScheme

        java.lang.String getScheme()
         The scheme portion of the incoming request URI.
        string scheme = 2;
        Returns:
        The scheme.

      • getSchemeBytes

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

      • getAuthority

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

      • getAuthorityBytes

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

      • hasPort

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

      • getPort

        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;
        Returns:
        The port.

      • getPortOrBuilder

        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;

      • getPath

        java.lang.String getPath()
         The path portion from the incoming request URI.
        string path = 5;
        Returns:
        The path.

      • getPathBytes

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

      • getUserAgent

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

      • getUserAgentBytes

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

      • getReferer

        java.lang.String getReferer()
         Value of the ``Referer`` request header.
        string referer = 7;
        Returns:
        The referer.

      • getRefererBytes

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

      • getForwardedFor

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

      • getForwardedForBytes

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

      • getRequestId

        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;
        Returns:
        The requestId.

      • getRequestIdBytes

        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;
        Returns:
        The bytes for requestId.

      • getOriginalPath

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

      • getOriginalPathBytes

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

      • getRequestHeadersBytes

        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;
        Returns:
        The requestHeadersBytes.

      • getRequestBodyBytes

        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;
        Returns:
        The requestBodyBytes.

      • getRequestHeadersCount

        int getRequestHeadersCount()
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;

      • containsRequestHeaders

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

      • getRequestHeaders

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getRequestHeaders()
        Deprecated.
        Use getRequestHeadersMap() instead.

      • getRequestHeadersMap

        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;

      • getRequestHeadersOrDefault

        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;

      • getRequestHeadersOrThrow

        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;