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

Class AttributeContext.HttpRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AttributeContext.HttpRequestOrBuilder, Serializable
    Enclosing class:
    AttributeContext
    public static final class AttributeContext.HttpRequest
extends com.google.protobuf.GeneratedMessageV3
implements AttributeContext.HttpRequestOrBuilder
     This message defines attributes for an HTTP request.
 HTTP/1.x, HTTP/2, gRPC are all considered as HTTP requests.
 [#next-free-field: 13]
    Protobuf type envoy.service.auth.v3.AttributeContext.HttpRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected 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

      • getId

        public 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;
        Specified by:
        getId in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The id.

      • getIdBytes

        public 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;
        Specified by:
        getIdBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for id.

      • getMethodBytes

        public com.google.protobuf.ByteString getMethodBytes()
         The HTTP request method, such as ``GET``, ``POST``.
        string method = 2;
        Specified by:
        getMethodBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for method.

      • containsHeaders

        public 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;
        Specified by:
        containsHeaders in interface AttributeContext.HttpRequestOrBuilder

      • getHeadersMap

        public 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;
        Specified by:
        getHeadersMap in interface AttributeContext.HttpRequestOrBuilder

      • getHeadersOrDefault

        public 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;
        Specified by:
        getHeadersOrDefault in interface AttributeContext.HttpRequestOrBuilder

      • getHeadersOrThrow

        public 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;
        Specified by:
        getHeadersOrThrow in interface AttributeContext.HttpRequestOrBuilder

      • getPath

        public 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;
        Specified by:
        getPath in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The path.

      • getPathBytes

        public 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;
        Specified by:
        getPathBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for path.

      • getHostBytes

        public com.google.protobuf.ByteString getHostBytes()
         The HTTP request ``Host`` or '`Authority`` header value.
        string host = 5;
        Specified by:
        getHostBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for host.

      • getSchemeBytes

        public com.google.protobuf.ByteString getSchemeBytes()
         The HTTP URL scheme, such as ``http`` and ``https``.
        string scheme = 6;
        Specified by:
        getSchemeBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for scheme.

      • getQuery

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

      • getQueryBytes

        public 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;
        Specified by:
        getQueryBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for query.

      • getFragment

        public 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;
        Specified by:
        getFragment in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The fragment.

      • getFragmentBytes

        public 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;
        Specified by:
        getFragmentBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for fragment.

      • getProtocol

        public 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;
        Specified by:
        getProtocol in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The protocol.

      • getProtocolBytes

        public 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;
        Specified by:
        getProtocolBytes in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The bytes for protocol.

      • getRawBody

        public 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;
        Specified by:
        getRawBody in interface AttributeContext.HttpRequestOrBuilder
        Returns:
        The rawBody.

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

      • parseFrom

        public static AttributeContext.HttpRequest parseFrom​(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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