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

    Modifier and Type
    Method
    Description
    boolean
    Map of additional headers that have been configured to be logged.
    HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
    com.google.protobuf.ByteString
    HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
    long
    Number of header bytes received from the downstream by the http stream, including protocol overhead.
    Value of the ``X-Forwarded-For`` request header.
    com.google.protobuf.ByteString
    Value of the ``X-Forwarded-For`` request header.
    Value of the ``X-Envoy-Original-Path`` request header.
    com.google.protobuf.ByteString
    Value of the ``X-Envoy-Original-Path`` request header.
    The path portion from the incoming request URI.
    com.google.protobuf.ByteString
    The path portion from the incoming request URI.
    com.google.protobuf.UInt32Value
    The port of the incoming request URI (unused currently, as port is composed onto authority).
    com.google.protobuf.UInt32ValueOrBuilder
    The port of the incoming request URI (unused currently, as port is composed onto authority).
    Value of the ``Referer`` request header.
    com.google.protobuf.ByteString
    Value of the ``Referer`` request header.
    long
    Size of the HTTP request body in bytes.
    Deprecated.
    long
    Size of the HTTP request headers in bytes.
    int
    Map of additional headers that have been configured to be logged.
    Map of additional headers that have been configured to be logged.
    Map of additional headers that have been configured to be logged.
    Map of additional headers that have been configured to be logged.
    Value of the ``X-Request-Id`` request header This header is used by Envoy to uniquely identify a request.
    com.google.protobuf.ByteString
    Value of the ``X-Request-Id`` request header This header is used by Envoy to uniquely identify a request.
    The request method (RFC 7231/2616).
    int
    The request method (RFC 7231/2616).
    The scheme portion of the incoming request URI.
    com.google.protobuf.ByteString
    The scheme portion of the incoming request URI.
    long
    Number of header bytes sent to the upstream by the http stream, including protocol overhead.
    Value of the ``User-Agent`` request header.
    com.google.protobuf.ByteString
    Value of the ``User-Agent`` request header.
    boolean
    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 Details

    • getRequestMethodValue

      int getRequestMethodValue()
       The request method (RFC 7231/2616).
       
      .envoy.config.core.v3.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.config.core.v3.RequestMethod request_method = 1 [(.validate.rules) = { ... }
      Returns:
      The requestMethod.
    • getScheme

      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

      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

      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

      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

      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

      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

      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

      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(String key)
       Map of additional headers that have been configured to be logged.
       
      map<string, string> request_headers = 13;
    • getRequestHeaders

      @Deprecated Map<String,String> getRequestHeaders()
      Deprecated.
    • getRequestHeadersMap

      Map<String,String> getRequestHeadersMap()
       Map of additional headers that have been configured to be logged.
       
      map<string, string> request_headers = 13;
    • getRequestHeadersOrDefault

      String getRequestHeadersOrDefault(String key, String defaultValue)
       Map of additional headers that have been configured to be logged.
       
      map<string, string> request_headers = 13;
    • getRequestHeadersOrThrow

      String getRequestHeadersOrThrow(String key)
       Map of additional headers that have been configured to be logged.
       
      map<string, string> request_headers = 13;
    • getUpstreamHeaderBytesSent

      long getUpstreamHeaderBytesSent()
       Number of header bytes sent to the upstream by the http stream, including protocol overhead.
      
       This value accumulates during upstream retries.
       
      uint64 upstream_header_bytes_sent = 14;
      Returns:
      The upstreamHeaderBytesSent.
    • getDownstreamHeaderBytesReceived

      long getDownstreamHeaderBytesReceived()
       Number of header bytes received from the downstream by the http stream, including protocol overhead.
       
      uint64 downstream_header_bytes_received = 15;
      Returns:
      The downstreamHeaderBytesReceived.