All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.envoyproxy.envoy.service.auth.v3.OkHttpResponseOrBuilder Maven / Gradle / Ivy

There is a newer version: 1.0.46
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/service/auth/v3/external_auth.proto

package io.envoyproxy.envoy.service.auth.v3;

public interface OkHttpResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.service.auth.v3.OkHttpResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   * 
   * 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; */ java.util.List 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; */ io.envoyproxy.envoy.config.core.v3.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; */ 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; */ java.util.List 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; */ io.envoyproxy.envoy.config.core.v3.HeaderValueOptionOrBuilder getHeadersOrBuilder( 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; * @return A list containing the headersToRemove. */ java.util.List 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; * @return The count of headersToRemove. */ 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; * @param index The index of the element to return. * @return The headersToRemove at the given index. */ java.lang.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; * @param index The index of the value to return. * @return The bytes of the headersToRemove at the given index. */ com.google.protobuf.ByteString getHeadersToRemoveBytes(int index); /** *
   * 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"]; * @deprecated envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated. * See envoy/service/auth/v3/external_auth.proto;l=98 * @return Whether the dynamicMetadata field is set. */ @java.lang.Deprecated boolean hasDynamicMetadata(); /** *
   * 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"]; * @deprecated envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated. * See envoy/service/auth/v3/external_auth.proto;l=98 * @return The dynamicMetadata. */ @java.lang.Deprecated com.google.protobuf.Struct getDynamicMetadata(); /** *
   * 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"]; */ @java.lang.Deprecated com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder(); /** *
   * 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; */ java.util.List 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; */ io.envoyproxy.envoy.config.core.v3.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; */ 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; */ java.util.List 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; */ io.envoyproxy.envoy.config.core.v3.HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder( 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; */ java.util.List 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; */ io.envoyproxy.envoy.config.core.v3.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; */ 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; */ java.util.List 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; */ io.envoyproxy.envoy.config.core.v3.QueryParameterOrBuilder getQueryParametersToSetOrBuilder( 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; * @return A list containing the queryParametersToRemove. */ java.util.List 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; * @return The count of queryParametersToRemove. */ 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; * @param index The index of the element to return. * @return The queryParametersToRemove at the given index. */ java.lang.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; * @param index The index of the value to return. * @return The bytes of the queryParametersToRemove at the given index. */ com.google.protobuf.ByteString getQueryParametersToRemoveBytes(int index); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy