Package io.envoyproxy.envoy.service.auth.v3

Interface AttributeContext.HttpRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsHeaders​(String key)
      The HTTP request headers.
      String getBody()
      The HTTP request body.
      com.google.protobuf.ByteString getBodyBytes()
      The HTTP request body.
      String getFragment()
      This field is always empty, and exists for compatibility reasons.
      com.google.protobuf.ByteString getFragmentBytes()
      This field is always empty, and exists for compatibility reasons.
      Map<String,​String> getHeaders()
      Deprecated.
      int getHeadersCount()
      The HTTP request headers.
      Map<String,​String> getHeadersMap()
      The HTTP request headers.
      String getHeadersOrDefault​(String key, String defaultValue)
      The HTTP request headers.
      String getHeadersOrThrow​(String key)
      The HTTP request headers.
      String getHost()
      The HTTP request ``Host`` or '`Authority`` header value.
      com.google.protobuf.ByteString getHostBytes()
      The HTTP request ``Host`` or '`Authority`` header value.
      String getId()
      The unique ID for a request, which can be propagated to downstream systems.
      com.google.protobuf.ByteString getIdBytes()
      The unique ID for a request, which can be propagated to downstream systems.
      String getMethod()
      The HTTP request method, such as ``GET``, ``POST``.
      com.google.protobuf.ByteString getMethodBytes()
      The HTTP request method, such as ``GET``, ``POST``.
      String getPath()
      The request target, as it appears in the first line of the HTTP request.
      com.google.protobuf.ByteString getPathBytes()
      The request target, as it appears in the first line of the HTTP request.
      String getProtocol()
      The network protocol used with the request, such as "HTTP/1.0", "HTTP/1.1", or "HTTP/2".
      com.google.protobuf.ByteString getProtocolBytes()
      The network protocol used with the request, such as "HTTP/1.0", "HTTP/1.1", or "HTTP/2".
      String getQuery()
      This field is always empty, and exists for compatibility reasons.
      com.google.protobuf.ByteString getQueryBytes()
      This field is always empty, and exists for compatibility reasons.
      com.google.protobuf.ByteString getRawBody()
      The HTTP request body in bytes.
      String getScheme()
      The HTTP URL scheme, such as ``http`` and ``https``.
      com.google.protobuf.ByteString getSchemeBytes()
      The HTTP URL scheme, such as ``http`` and ``https``.
      long getSize()
      The HTTP request size in bytes.

      • 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

      • getId

        String getId()
         The unique ID for a request, which can be propagated to downstream
 systems. The ID should have low probability of collision
 within a single day for a specific service.
 For HTTP requests, it should be X-Request-ID or equivalent.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         The unique ID for a request, which can be propagated to downstream
 systems. The ID should have low probability of collision
 within a single day for a specific service.
 For HTTP requests, it should be X-Request-ID or equivalent.
        string id = 1;
        Returns:
        The bytes for id.

      • getMethod

        String getMethod()
         The HTTP request method, such as ``GET``, ``POST``.
        string method = 2;
        Returns:
        The method.

      • getMethodBytes

        com.google.protobuf.ByteString getMethodBytes()
         The HTTP request method, such as ``GET``, ``POST``.
        string method = 2;
        Returns:
        The bytes for method.

      • getHeadersCount

        int getHeadersCount()
         The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lower-cased, because HTTP header keys are case-insensitive.
        map<string, string> headers = 3;

      • containsHeaders

        boolean containsHeaders​(String key)
         The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lower-cased, because HTTP header keys are case-insensitive.
        map<string, string> headers = 3;

      • getHeadersMap

        Map<String,​String> getHeadersMap()
         The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lower-cased, because HTTP header keys are case-insensitive.
        map<string, string> headers = 3;

      • getHeadersOrDefault

        String getHeadersOrDefault​(String key,
                           String defaultValue)
         The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lower-cased, because HTTP header keys are case-insensitive.
        map<string, string> headers = 3;

      • getHeadersOrThrow

        String getHeadersOrThrow​(String key)
         The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lower-cased, because HTTP header keys are case-insensitive.
        map<string, string> headers = 3;

      • getPath

        String getPath()
         The request target, as it appears in the first line of the HTTP request. This includes
 the URL path and query-string. No decoding is performed.
        string path = 4;
        Returns:
        The path.

      • getPathBytes

        com.google.protobuf.ByteString getPathBytes()
         The request target, as it appears in the first line of the HTTP request. This includes
 the URL path and query-string. No decoding is performed.
        string path = 4;
        Returns:
        The bytes for path.

      • getHost

        String getHost()
         The HTTP request ``Host`` or '`Authority`` header value.
        string host = 5;
        Returns:
        The host.

      • getHostBytes

        com.google.protobuf.ByteString getHostBytes()
         The HTTP request ``Host`` or '`Authority`` header value.
        string host = 5;
        Returns:
        The bytes for host.

      • getScheme

        String getScheme()
         The HTTP URL scheme, such as ``http`` and ``https``.
        string scheme = 6;
        Returns:
        The scheme.

      • getSchemeBytes

        com.google.protobuf.ByteString getSchemeBytes()
         The HTTP URL scheme, such as ``http`` and ``https``.
        string scheme = 6;
        Returns:
        The bytes for scheme.

      • getQuery

        String getQuery()
         This field is always empty, and exists for compatibility reasons. The HTTP URL query is
 included in ``path`` field.
        string query = 7;
        Returns:
        The query.

      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         This field is always empty, and exists for compatibility reasons. The HTTP URL query is
 included in ``path`` field.
        string query = 7;
        Returns:
        The bytes for query.

      • getFragment

        String getFragment()
         This field is always empty, and exists for compatibility reasons. The URL fragment is
 not submitted as part of HTTP requests; it is unknowable.
        string fragment = 8;
        Returns:
        The fragment.

      • getFragmentBytes

        com.google.protobuf.ByteString getFragmentBytes()
         This field is always empty, and exists for compatibility reasons. The URL fragment is
 not submitted as part of HTTP requests; it is unknowable.
        string fragment = 8;
        Returns:
        The bytes for fragment.

      • getSize

        long getSize()
         The HTTP request size in bytes. If unknown, it must be -1.
        int64 size = 9;
        Returns:
        The size.

      • getProtocol

        String getProtocol()
         The network protocol used with the request, such as "HTTP/1.0", "HTTP/1.1", or "HTTP/2".
 See :repo:`headers.h:ProtocolStrings <source/common/http/headers.h>` for a list of all
 possible values.
        string protocol = 10;
        Returns:
        The protocol.

      • getProtocolBytes

        com.google.protobuf.ByteString getProtocolBytes()
         The network protocol used with the request, such as "HTTP/1.0", "HTTP/1.1", or "HTTP/2".
 See :repo:`headers.h:ProtocolStrings <source/common/http/headers.h>` for a list of all
 possible values.
        string protocol = 10;
        Returns:
        The bytes for protocol.

      • getBody

        String getBody()
         The HTTP request body.
        string body = 11;
        Returns:
        The body.

      • getBodyBytes

        com.google.protobuf.ByteString getBodyBytes()
         The HTTP request body.
        string body = 11;
        Returns:
        The bytes for body.

      • getRawBody

        com.google.protobuf.ByteString getRawBody()
         The HTTP request body in bytes. This is used instead of
 :ref:`body <envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body>` when
 :ref:`pack_as_bytes <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.BufferSettings.pack_as_bytes>`
 is set to true.
        bytes raw_body = 12;
        Returns:
        The rawBody.