HTTPRequestPropertiesOrBuilder (api 0.1.28 API)

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 and Description
`boolean`	`containsRequestHeaders(String key)` Map of additional headers that have been configured to be logged.
`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.
`String`	`getForwardedFor()` Value of the ``X-Forwarded-For`` request header.
`com.google.protobuf.ByteString`	`getForwardedForBytes()` Value of the ``X-Forwarded-For`` request header.
`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.
`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).
`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.
`Map<String,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.
`Map<String,String>`	`getRequestHeadersMap()` Map of additional headers that have been configured to be logged.
`String`	`getRequestHeadersOrDefault(String key, String defaultValue)` Map of additional headers that have been configured to be logged.
`String`	`getRequestHeadersOrThrow(String key)` Map of additional headers that have been configured to be logged.
`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).
`String`	`getScheme()` The scheme portion of the incoming request URI.
`com.google.protobuf.ByteString`	`getSchemeBytes()` The scheme portion of the incoming request URI.
`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.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

Method Detail

getRequestMethodValue
```
int getRequestMethodValue()
```
```
 The request method (RFC 7231/2616).
 
```
.envoy.config.core.v3.RequestMethod request_method = 1 [(.validate.rules) = { ... }

getRequestMethod
```
RequestMethod getRequestMethod()
```
```
 The request method (RFC 7231/2616).
 
```
.envoy.config.core.v3.RequestMethod request_method = 1 [(.validate.rules) = { ... }

getScheme

String getScheme()

 The scheme portion of the incoming request URI.

string scheme = 2;

getSchemeBytes

com.google.protobuf.ByteString getSchemeBytes()

 The scheme portion of the incoming request URI.

string scheme = 2;

getAuthority

String getAuthority()

 HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.

string authority = 3;

getAuthorityBytes

com.google.protobuf.ByteString getAuthorityBytes()

 HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.

string authority = 3;

hasPort

boolean hasPort()

 The port of the incoming request URI
 (unused currently, as port is composed onto authority).

.google.protobuf.UInt32Value port = 4;

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;

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;

getPathBytes

com.google.protobuf.ByteString getPathBytes()

 The path portion from the incoming request URI.

string path = 5;

getUserAgent

String getUserAgent()

 Value of the ``User-Agent`` request header.

string user_agent = 6;

getUserAgentBytes

com.google.protobuf.ByteString getUserAgentBytes()

 Value of the ``User-Agent`` request header.

string user_agent = 6;

getReferer

String getReferer()

 Value of the ``Referer`` request header.

string referer = 7;

getRefererBytes

com.google.protobuf.ByteString getRefererBytes()

 Value of the ``Referer`` request header.

string referer = 7;

getForwardedFor

String getForwardedFor()

 Value of the ``X-Forwarded-For`` request header.

string forwarded_for = 8;

getForwardedForBytes

com.google.protobuf.ByteString getForwardedForBytes()

 Value of the ``X-Forwarded-For`` request header.

string forwarded_for = 8;

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;

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;

getOriginalPath

String getOriginalPath()

 Value of the ``X-Envoy-Original-Path`` request header.

string original_path = 10;

getOriginalPathBytes

com.google.protobuf.ByteString getOriginalPathBytes()

 Value of the ``X-Envoy-Original-Path`` request header.

string original_path = 10;

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;

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;