Package io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3

Class HttpService.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpServiceOrBuilder, Cloneable
    Enclosing class:
    HttpService
    public static final class HttpService.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<HttpService.Builder>
implements HttpServiceOrBuilder
     HttpService is used for raw HTTP communication between the filter and the authorization service.
 When configured, the filter will parse the client request and use these attributes to call the
 authorization server. Depending on the response, the filter may reject or accept the client
 request. Note that in any of these events, metadata can be added, removed or overridden by the
 filter:
 *On authorization request*, a list of allowed request headers may be supplied. See
 :ref:`allowed_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers>`
 for details. Additional headers metadata may be added to the authorization request. See
 :ref:`headers_to_add
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationRequest.headers_to_add>` for
 details.
 On authorization response status HTTP 200 OK, the filter will allow traffic to the upstream and
 additional headers metadata may be added to the original client request. See
 :ref:`allowed_upstream_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_upstream_headers>`
 for details. Additionally, the filter may add additional headers to the client's response. See
 :ref:`allowed_client_headers_on_success
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_client_headers_on_success>`
 for details.
 On other authorization response statuses, the filter will not allow traffic. Additional headers
 metadata as well as body may be added to the client's response. See :ref:`allowed_client_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_client_headers>`
 for details.
 [#next-free-field: 9]
    Protobuf type envoy.extensions.filters.http.ext_authz.v3.HttpService

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

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

      • clear

        public HttpService.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<HttpService.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<HttpService.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public HttpService.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<HttpService.Builder>

      • setField

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

      • clearField

        public HttpService.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<HttpService.Builder>

      • clearOneof

        public HttpService.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<HttpService.Builder>

      • setRepeatedField

        public HttpService.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<HttpService.Builder>

      • addRepeatedField

        public HttpService.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<HttpService.Builder>

      • mergeFrom

        public HttpService.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpService.Builder>

      • isInitialized

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

      • mergeFrom

        public HttpService.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<HttpService.Builder>
        Throws:
        IOException

      • hasServerUri

        public boolean hasServerUri()
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;
        Specified by:
        hasServerUri in interface HttpServiceOrBuilder
        Returns:
        Whether the serverUri field is set.

      • getServerUri

        public HttpUri getServerUri()
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;
        Specified by:
        getServerUri in interface HttpServiceOrBuilder
        Returns:
        The serverUri.

      • setServerUri

        public HttpService.Builder setServerUri​(HttpUri value)
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;

      • setServerUri

        public HttpService.Builder setServerUri​(HttpUri.Builder builderForValue)
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;

      • mergeServerUri

        public HttpService.Builder mergeServerUri​(HttpUri value)
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;

      • clearServerUri

        public HttpService.Builder clearServerUri()
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;

      • getServerUriBuilder

        public HttpUri.Builder getServerUriBuilder()
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;

      • getPathPrefix

        public String getPathPrefix()
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Specified by:
        getPathPrefix in interface HttpServiceOrBuilder
        Returns:
        The pathPrefix.

      • getPathPrefixBytes

        public com.google.protobuf.ByteString getPathPrefixBytes()
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Specified by:
        getPathPrefixBytes in interface HttpServiceOrBuilder
        Returns:
        The bytes for pathPrefix.

      • setPathPrefix

        public HttpService.Builder setPathPrefix​(String value)
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Parameters:
        value - The pathPrefix to set.
        Returns:
        This builder for chaining.

      • clearPathPrefix

        public HttpService.Builder clearPathPrefix()
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Returns:
        This builder for chaining.

      • setPathPrefixBytes

        public HttpService.Builder setPathPrefixBytes​(com.google.protobuf.ByteString value)
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Parameters:
        value - The bytes for pathPrefix to set.
        Returns:
        This builder for chaining.

      • hasAuthorizationRequest

        public boolean hasAuthorizationRequest()
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;
        Specified by:
        hasAuthorizationRequest in interface HttpServiceOrBuilder
        Returns:
        Whether the authorizationRequest field is set.

      • getAuthorizationRequest

        public AuthorizationRequest getAuthorizationRequest()
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;
        Specified by:
        getAuthorizationRequest in interface HttpServiceOrBuilder
        Returns:
        The authorizationRequest.

      • setAuthorizationRequest

        public HttpService.Builder setAuthorizationRequest​(AuthorizationRequest value)
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;

      • setAuthorizationRequest

        public HttpService.Builder setAuthorizationRequest​(AuthorizationRequest.Builder builderForValue)
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;

      • mergeAuthorizationRequest

        public HttpService.Builder mergeAuthorizationRequest​(AuthorizationRequest value)
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;

      • clearAuthorizationRequest

        public HttpService.Builder clearAuthorizationRequest()
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;

      • getAuthorizationRequestBuilder

        public AuthorizationRequest.Builder getAuthorizationRequestBuilder()
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;

      • hasAuthorizationResponse

        public boolean hasAuthorizationResponse()
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;
        Specified by:
        hasAuthorizationResponse in interface HttpServiceOrBuilder
        Returns:
        Whether the authorizationResponse field is set.

      • getAuthorizationResponse

        public AuthorizationResponse getAuthorizationResponse()
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;
        Specified by:
        getAuthorizationResponse in interface HttpServiceOrBuilder
        Returns:
        The authorizationResponse.

      • setAuthorizationResponse

        public HttpService.Builder setAuthorizationResponse​(AuthorizationResponse value)
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;

      • setAuthorizationResponse

        public HttpService.Builder setAuthorizationResponse​(AuthorizationResponse.Builder builderForValue)
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;

      • mergeAuthorizationResponse

        public HttpService.Builder mergeAuthorizationResponse​(AuthorizationResponse value)
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;

      • clearAuthorizationResponse

        public HttpService.Builder clearAuthorizationResponse()
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;

      • getAuthorizationResponseBuilder

        public AuthorizationResponse.Builder getAuthorizationResponseBuilder()
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;

      • setUnknownFields

        public final HttpService.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<HttpService.Builder>

      • mergeUnknownFields

        public final HttpService.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<HttpService.Builder>