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

Class HTTPRequestProperties.Builder

    • Method Detail

      • 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.Builder<HTTPRequestProperties.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • clear

        public HTTPRequestProperties.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • getDefaultInstanceForType

        public HTTPRequestProperties getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public HTTPRequestProperties build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public HTTPRequestProperties buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public HTTPRequestProperties.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • clearField

        public HTTPRequestProperties.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • clearOneof

        public HTTPRequestProperties.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • setRepeatedField

        public HTTPRequestProperties.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • addRepeatedField

        public HTTPRequestProperties.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • mergeFrom

        public HTTPRequestProperties.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HTTPRequestProperties.Builder>
        Throws:
        IOException

      • getRequestMethodValue

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

      • setRequestMethodValue

        public HTTPRequestProperties.Builder setRequestMethodValue​(int value)
         The request method (RFC 7231/2616).
        .envoy.api.v2.core.RequestMethod request_method = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The enum numeric value on the wire for requestMethod to set.
        Returns:
        This builder for chaining.

      • setRequestMethod

        public HTTPRequestProperties.Builder setRequestMethod​(RequestMethod value)
         The request method (RFC 7231/2616).
        .envoy.api.v2.core.RequestMethod request_method = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The requestMethod to set.
        Returns:
        This builder for chaining.

      • clearRequestMethod

        public HTTPRequestProperties.Builder clearRequestMethod()
         The request method (RFC 7231/2616).
        .envoy.api.v2.core.RequestMethod request_method = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • getSchemeBytes

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

      • setScheme

        public HTTPRequestProperties.Builder setScheme​(String value)
         The scheme portion of the incoming request URI.
        string scheme = 2;
        Parameters:
        value - The scheme to set.
        Returns:
        This builder for chaining.

      • clearScheme

        public HTTPRequestProperties.Builder clearScheme()
         The scheme portion of the incoming request URI.
        string scheme = 2;
        Returns:
        This builder for chaining.

      • setSchemeBytes

        public HTTPRequestProperties.Builder setSchemeBytes​(com.google.protobuf.ByteString value)
         The scheme portion of the incoming request URI.
        string scheme = 2;
        Parameters:
        value - The bytes for scheme to set.
        Returns:
        This builder for chaining.

      • getAuthorityBytes

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

      • setAuthority

        public HTTPRequestProperties.Builder setAuthority​(String value)
         HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
        string authority = 3;
        Parameters:
        value - The authority to set.
        Returns:
        This builder for chaining.

      • clearAuthority

        public HTTPRequestProperties.Builder clearAuthority()
         HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
        string authority = 3;
        Returns:
        This builder for chaining.

      • setAuthorityBytes

        public HTTPRequestProperties.Builder setAuthorityBytes​(com.google.protobuf.ByteString value)
         HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.
        string authority = 3;
        Parameters:
        value - The bytes for authority to set.
        Returns:
        This builder for chaining.

      • hasPort

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

      • getPort

        public 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;
        Specified by:
        getPort in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The port.

      • setPort

        public HTTPRequestProperties.Builder setPort​(com.google.protobuf.UInt32Value value)
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;

      • setPort

        public HTTPRequestProperties.Builder setPort​(com.google.protobuf.UInt32Value.Builder builderForValue)
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;

      • mergePort

        public HTTPRequestProperties.Builder mergePort​(com.google.protobuf.UInt32Value value)
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;

      • clearPort

        public HTTPRequestProperties.Builder clearPort()
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;

      • getPortBuilder

        public com.google.protobuf.UInt32Value.Builder getPortBuilder()
         The port of the incoming request URI
 (unused currently, as port is composed onto authority).
        .google.protobuf.UInt32Value port = 4;

      • getPortOrBuilder

        public 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;
        Specified by:
        getPortOrBuilder in interface HTTPRequestPropertiesOrBuilder

      • getPathBytes

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

      • setPath

        public HTTPRequestProperties.Builder setPath​(String value)
         The path portion from the incoming request URI.
        string path = 5;
        Parameters:
        value - The path to set.
        Returns:
        This builder for chaining.

      • clearPath

        public HTTPRequestProperties.Builder clearPath()
         The path portion from the incoming request URI.
        string path = 5;
        Returns:
        This builder for chaining.

      • setPathBytes

        public HTTPRequestProperties.Builder setPathBytes​(com.google.protobuf.ByteString value)
         The path portion from the incoming request URI.
        string path = 5;
        Parameters:
        value - The bytes for path to set.
        Returns:
        This builder for chaining.

      • getUserAgentBytes

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

      • setUserAgent

        public HTTPRequestProperties.Builder setUserAgent​(String value)
         Value of the ``User-Agent`` request header.
        string user_agent = 6;
        Parameters:
        value - The userAgent to set.
        Returns:
        This builder for chaining.

      • clearUserAgent

        public HTTPRequestProperties.Builder clearUserAgent()
         Value of the ``User-Agent`` request header.
        string user_agent = 6;
        Returns:
        This builder for chaining.

      • setUserAgentBytes

        public HTTPRequestProperties.Builder setUserAgentBytes​(com.google.protobuf.ByteString value)
         Value of the ``User-Agent`` request header.
        string user_agent = 6;
        Parameters:
        value - The bytes for userAgent to set.
        Returns:
        This builder for chaining.

      • getRefererBytes

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

      • setReferer

        public HTTPRequestProperties.Builder setReferer​(String value)
         Value of the ``Referer`` request header.
        string referer = 7;
        Parameters:
        value - The referer to set.
        Returns:
        This builder for chaining.

      • clearReferer

        public HTTPRequestProperties.Builder clearReferer()
         Value of the ``Referer`` request header.
        string referer = 7;
        Returns:
        This builder for chaining.

      • setRefererBytes

        public HTTPRequestProperties.Builder setRefererBytes​(com.google.protobuf.ByteString value)
         Value of the ``Referer`` request header.
        string referer = 7;
        Parameters:
        value - The bytes for referer to set.
        Returns:
        This builder for chaining.

      • getForwardedForBytes

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

      • setForwardedFor

        public HTTPRequestProperties.Builder setForwardedFor​(String value)
         Value of the ``X-Forwarded-For`` request header.
        string forwarded_for = 8;
        Parameters:
        value - The forwardedFor to set.
        Returns:
        This builder for chaining.

      • clearForwardedFor

        public HTTPRequestProperties.Builder clearForwardedFor()
         Value of the ``X-Forwarded-For`` request header.
        string forwarded_for = 8;
        Returns:
        This builder for chaining.

      • setForwardedForBytes

        public HTTPRequestProperties.Builder setForwardedForBytes​(com.google.protobuf.ByteString value)
         Value of the ``X-Forwarded-For`` request header.
        string forwarded_for = 8;
        Parameters:
        value - The bytes for forwardedFor to set.
        Returns:
        This builder for chaining.

      • getRequestId

        public 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;
        Specified by:
        getRequestId in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The requestId.

      • getRequestIdBytes

        public 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;
        Specified by:
        getRequestIdBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The bytes for requestId.

      • setRequestId

        public HTTPRequestProperties.Builder setRequestId​(String value)
         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;
        Parameters:
        value - The requestId to set.
        Returns:
        This builder for chaining.

      • clearRequestId

        public HTTPRequestProperties.Builder clearRequestId()
         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:
        This builder for chaining.

      • setRequestIdBytes

        public HTTPRequestProperties.Builder setRequestIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for requestId to set.
        Returns:
        This builder for chaining.

      • getOriginalPathBytes

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

      • setOriginalPath

        public HTTPRequestProperties.Builder setOriginalPath​(String value)
         Value of the ``X-Envoy-Original-Path`` request header.
        string original_path = 10;
        Parameters:
        value - The originalPath to set.
        Returns:
        This builder for chaining.

      • clearOriginalPath

        public HTTPRequestProperties.Builder clearOriginalPath()
         Value of the ``X-Envoy-Original-Path`` request header.
        string original_path = 10;
        Returns:
        This builder for chaining.

      • setOriginalPathBytes

        public HTTPRequestProperties.Builder setOriginalPathBytes​(com.google.protobuf.ByteString value)
         Value of the ``X-Envoy-Original-Path`` request header.
        string original_path = 10;
        Parameters:
        value - The bytes for originalPath to set.
        Returns:
        This builder for chaining.

      • getRequestHeadersBytes

        public 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;
        Specified by:
        getRequestHeadersBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The requestHeadersBytes.

      • setRequestHeadersBytes

        public HTTPRequestProperties.Builder setRequestHeadersBytes​(long value)
         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;
        Parameters:
        value - The requestHeadersBytes to set.
        Returns:
        This builder for chaining.

      • clearRequestHeadersBytes

        public HTTPRequestProperties.Builder clearRequestHeadersBytes()
         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:
        This builder for chaining.

      • getRequestBodyBytes

        public 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;
        Specified by:
        getRequestBodyBytes in interface HTTPRequestPropertiesOrBuilder
        Returns:
        The requestBodyBytes.

      • setRequestBodyBytes

        public HTTPRequestProperties.Builder setRequestBodyBytes​(long value)
         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;
        Parameters:
        value - The requestBodyBytes to set.
        Returns:
        This builder for chaining.

      • clearRequestBodyBytes

        public HTTPRequestProperties.Builder clearRequestBodyBytes()
         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:
        This builder for chaining.

      • removeRequestHeaders

        public HTTPRequestProperties.Builder removeRequestHeaders​(String key)
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;

      • getMutableRequestHeaders

        @Deprecated
public Map<String,​String> getMutableRequestHeaders()
        Deprecated.
        Use alternate mutation accessors instead.

      • putRequestHeaders

        public HTTPRequestProperties.Builder putRequestHeaders​(String key,
                                                       String value)
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;

      • putAllRequestHeaders

        public HTTPRequestProperties.Builder putAllRequestHeaders​(Map<String,​String> values)
         Map of additional headers that have been configured to be logged.
        map<string, string> request_headers = 13;

      • setUnknownFields

        public final HTTPRequestProperties.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>

      • mergeUnknownFields

        public final HTTPRequestProperties.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HTTPRequestProperties.Builder>