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

Interface OkHttpResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    OkHttpResponse, OkHttpResponse.Builder
    public interface OkHttpResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getHeadersList

        List<HeaderValueOption> getHeadersList()
         HTTP entity headers in addition to the original request headers. This allows the authorization
 service to append, to add or to override headers from the original request before
 dispatching it to the upstream. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>` defaults to
 false when used in this message. By setting the ``append`` field to ``true``,
 the filter will append the correspondent header value to the matched request header.
 By leaving ``append`` as false, the filter will either add a new header, or override an existing
 one if there is a match.
        repeated .envoy.config.core.v3.HeaderValueOption headers = 2;

      • getHeaders

        HeaderValueOption getHeaders​(int index)
         HTTP entity headers in addition to the original request headers. This allows the authorization
 service to append, to add or to override headers from the original request before
 dispatching it to the upstream. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>` defaults to
 false when used in this message. By setting the ``append`` field to ``true``,
 the filter will append the correspondent header value to the matched request header.
 By leaving ``append`` as false, the filter will either add a new header, or override an existing
 one if there is a match.
        repeated .envoy.config.core.v3.HeaderValueOption headers = 2;

      • getHeadersCount

        int getHeadersCount()
         HTTP entity headers in addition to the original request headers. This allows the authorization
 service to append, to add or to override headers from the original request before
 dispatching it to the upstream. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>` defaults to
 false when used in this message. By setting the ``append`` field to ``true``,
 the filter will append the correspondent header value to the matched request header.
 By leaving ``append`` as false, the filter will either add a new header, or override an existing
 one if there is a match.
        repeated .envoy.config.core.v3.HeaderValueOption headers = 2;

      • getHeadersOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getHeadersOrBuilderList()
         HTTP entity headers in addition to the original request headers. This allows the authorization
 service to append, to add or to override headers from the original request before
 dispatching it to the upstream. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>` defaults to
 false when used in this message. By setting the ``append`` field to ``true``,
 the filter will append the correspondent header value to the matched request header.
 By leaving ``append`` as false, the filter will either add a new header, or override an existing
 one if there is a match.
        repeated .envoy.config.core.v3.HeaderValueOption headers = 2;

      • getHeadersOrBuilder

        HeaderValueOptionOrBuilder getHeadersOrBuilder​(int index)
         HTTP entity headers in addition to the original request headers. This allows the authorization
 service to append, to add or to override headers from the original request before
 dispatching it to the upstream. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>` defaults to
 false when used in this message. By setting the ``append`` field to ``true``,
 the filter will append the correspondent header value to the matched request header.
 By leaving ``append`` as false, the filter will either add a new header, or override an existing
 one if there is a match.
        repeated .envoy.config.core.v3.HeaderValueOption headers = 2;

      • getHeadersToRemoveList

        List<String> getHeadersToRemoveList()
         HTTP entity headers to remove from the original request before dispatching
 it to the upstream. This allows the authorization service to act on auth
 related headers (like ``Authorization``), process them, and consume them.
 Under this model, the upstream will either receive the request (if it's
 authorized) or not receive it (if it's not), but will not see headers
 containing authorization credentials.
 Pseudo headers (such as ``:authority``, ``:method``, ``:path`` etc), as well as
 the header ``Host``, may not be removed as that would make the request
 malformed. If mentioned in ``headers_to_remove`` these special headers will
 be ignored.
 When using the HTTP service this must instead be set by the HTTP
 authorization service as a comma separated list like so:
 ``x-envoy-auth-headers-to-remove: one-auth-header, another-auth-header``.
        repeated string headers_to_remove = 5;
        Returns:
        A list containing the headersToRemove.

      • getHeadersToRemoveCount

        int getHeadersToRemoveCount()
         HTTP entity headers to remove from the original request before dispatching
 it to the upstream. This allows the authorization service to act on auth
 related headers (like ``Authorization``), process them, and consume them.
 Under this model, the upstream will either receive the request (if it's
 authorized) or not receive it (if it's not), but will not see headers
 containing authorization credentials.
 Pseudo headers (such as ``:authority``, ``:method``, ``:path`` etc), as well as
 the header ``Host``, may not be removed as that would make the request
 malformed. If mentioned in ``headers_to_remove`` these special headers will
 be ignored.
 When using the HTTP service this must instead be set by the HTTP
 authorization service as a comma separated list like so:
 ``x-envoy-auth-headers-to-remove: one-auth-header, another-auth-header``.
        repeated string headers_to_remove = 5;
        Returns:
        The count of headersToRemove.

      • getHeadersToRemove

        String getHeadersToRemove​(int index)
         HTTP entity headers to remove from the original request before dispatching
 it to the upstream. This allows the authorization service to act on auth
 related headers (like ``Authorization``), process them, and consume them.
 Under this model, the upstream will either receive the request (if it's
 authorized) or not receive it (if it's not), but will not see headers
 containing authorization credentials.
 Pseudo headers (such as ``:authority``, ``:method``, ``:path`` etc), as well as
 the header ``Host``, may not be removed as that would make the request
 malformed. If mentioned in ``headers_to_remove`` these special headers will
 be ignored.
 When using the HTTP service this must instead be set by the HTTP
 authorization service as a comma separated list like so:
 ``x-envoy-auth-headers-to-remove: one-auth-header, another-auth-header``.
        repeated string headers_to_remove = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The headersToRemove at the given index.

      • getHeadersToRemoveBytes

        com.google.protobuf.ByteString getHeadersToRemoveBytes​(int index)
         HTTP entity headers to remove from the original request before dispatching
 it to the upstream. This allows the authorization service to act on auth
 related headers (like ``Authorization``), process them, and consume them.
 Under this model, the upstream will either receive the request (if it's
 authorized) or not receive it (if it's not), but will not see headers
 containing authorization credentials.
 Pseudo headers (such as ``:authority``, ``:method``, ``:path`` etc), as well as
 the header ``Host``, may not be removed as that would make the request
 malformed. If mentioned in ``headers_to_remove`` these special headers will
 be ignored.
 When using the HTTP service this must instead be set by the HTTP
 authorization service as a comma separated list like so:
 ``x-envoy-auth-headers-to-remove: one-auth-header, another-auth-header``.
        repeated string headers_to_remove = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the headersToRemove at the given index.

      • hasDynamicMetadata

        @Deprecated
boolean hasDynamicMetadata()
        Deprecated.
        envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated. See envoy/service/auth/v3/external_auth.proto;l=98
         This field has been deprecated in favor of :ref:`CheckResponse.dynamic_metadata
 <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`. Until it is removed,
 setting this field overrides :ref:`CheckResponse.dynamic_metadata
 <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`.
        .google.protobuf.Struct dynamic_metadata = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        Whether the dynamicMetadata field is set.

      • getDynamicMetadata

        @Deprecated
com.google.protobuf.Struct getDynamicMetadata()
        Deprecated.
        envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated. See envoy/service/auth/v3/external_auth.proto;l=98
         This field has been deprecated in favor of :ref:`CheckResponse.dynamic_metadata
 <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`. Until it is removed,
 setting this field overrides :ref:`CheckResponse.dynamic_metadata
 <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`.
        .google.protobuf.Struct dynamic_metadata = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The dynamicMetadata.

      • getDynamicMetadataOrBuilder

        @Deprecated
com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
        Deprecated.
         This field has been deprecated in favor of :ref:`CheckResponse.dynamic_metadata
 <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`. Until it is removed,
 setting this field overrides :ref:`CheckResponse.dynamic_metadata
 <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`.
        .google.protobuf.Struct dynamic_metadata = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

      • getResponseHeadersToAddList

        List<HeaderValueOption> getResponseHeadersToAddList()
         This field allows the authorization service to send HTTP response headers
 to the downstream client on success. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>`
 defaults to false when used in this message.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6;

      • getResponseHeadersToAdd

        HeaderValueOption getResponseHeadersToAdd​(int index)
         This field allows the authorization service to send HTTP response headers
 to the downstream client on success. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>`
 defaults to false when used in this message.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6;

      • getResponseHeadersToAddCount

        int getResponseHeadersToAddCount()
         This field allows the authorization service to send HTTP response headers
 to the downstream client on success. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>`
 defaults to false when used in this message.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6;

      • getResponseHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()
         This field allows the authorization service to send HTTP response headers
 to the downstream client on success. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>`
 defaults to false when used in this message.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6;

      • getResponseHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder​(int index)
         This field allows the authorization service to send HTTP response headers
 to the downstream client on success. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>`
 defaults to false when used in this message.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6;

      • getQueryParametersToSetList

        List<QueryParameter> getQueryParametersToSetList()
         This field allows the authorization service to set (and overwrite) query
 string parameters on the original request before it is sent upstream.
        repeated .envoy.config.core.v3.QueryParameter query_parameters_to_set = 7;

      • getQueryParametersToSet

        QueryParameter getQueryParametersToSet​(int index)
         This field allows the authorization service to set (and overwrite) query
 string parameters on the original request before it is sent upstream.
        repeated .envoy.config.core.v3.QueryParameter query_parameters_to_set = 7;

      • getQueryParametersToSetCount

        int getQueryParametersToSetCount()
         This field allows the authorization service to set (and overwrite) query
 string parameters on the original request before it is sent upstream.
        repeated .envoy.config.core.v3.QueryParameter query_parameters_to_set = 7;

      • getQueryParametersToSetOrBuilderList

        List<? extends QueryParameterOrBuilder> getQueryParametersToSetOrBuilderList()
         This field allows the authorization service to set (and overwrite) query
 string parameters on the original request before it is sent upstream.
        repeated .envoy.config.core.v3.QueryParameter query_parameters_to_set = 7;

      • getQueryParametersToSetOrBuilder

        QueryParameterOrBuilder getQueryParametersToSetOrBuilder​(int index)
         This field allows the authorization service to set (and overwrite) query
 string parameters on the original request before it is sent upstream.
        repeated .envoy.config.core.v3.QueryParameter query_parameters_to_set = 7;

      • getQueryParametersToRemoveList

        List<String> getQueryParametersToRemoveList()
         This field allows the authorization service to specify which query parameters
 should be removed from the original request before it is sent upstream. Each
 element in this list is a case-sensitive query parameter name to be removed.
        repeated string query_parameters_to_remove = 8;
        Returns:
        A list containing the queryParametersToRemove.

      • getQueryParametersToRemoveCount

        int getQueryParametersToRemoveCount()
         This field allows the authorization service to specify which query parameters
 should be removed from the original request before it is sent upstream. Each
 element in this list is a case-sensitive query parameter name to be removed.
        repeated string query_parameters_to_remove = 8;
        Returns:
        The count of queryParametersToRemove.

      • getQueryParametersToRemove

        String getQueryParametersToRemove​(int index)
         This field allows the authorization service to specify which query parameters
 should be removed from the original request before it is sent upstream. Each
 element in this list is a case-sensitive query parameter name to be removed.
        repeated string query_parameters_to_remove = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The queryParametersToRemove at the given index.

      • getQueryParametersToRemoveBytes

        com.google.protobuf.ByteString getQueryParametersToRemoveBytes​(int index)
         This field allows the authorization service to specify which query parameters
 should be removed from the original request before it is sent upstream. Each
 element in this list is a case-sensitive query parameter name to be removed.
        repeated string query_parameters_to_remove = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the queryParametersToRemove at the given index.