envoy.config.filter.http.ext_authz.v2alpha

Class ExtAuthzOuterClass.HttpService.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthzOuterClass.HttpService.Builder>

envoy.config.filter.http.ext_authz.v2alpha.ExtAuthzOuterClass.HttpService.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtAuthzOuterClass.HttpServiceOrBuilder, Cloneable

Enclosing class:

ExtAuthzOuterClass.HttpService

public static final class ExtAuthzOuterClass.HttpService.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthzOuterClass.HttpService.Builder>
implements ExtAuthzOuterClass.HttpServiceOrBuilder

 External Authorization filter calls out to an upstream authorization server by passing the raw
 HTTP request headers to the server. This allows the authorization service to take a decision
 whether the request is authorized or not.
 A successful check allows the authorization service adding or overriding headers from the
 original request before dispatching it to the upstream. This is done by including the headers in
 the response sent back from the authorization service to the filter. Note that `Status`,
 `Method`, `Path` and `Content Length` response headers are automatically removed from this
 response by the filter. If other headers need be deleted, they should be specified in
 `response_headers_to_remove` field.
 A failed check will cause this filter to close the HTTP request normally with 403 (Forbidden),
 unless a different status code has been indicated by the authorization service via response
 headers. The HTTP service also allows the authorization filter to also pass data from the
 response body to the downstream client in case of a denied request.
 

Protobuf type envoy.config.filter.http.ext_authz.v2alpha.HttpService

Method Summary

Modifier and Type	Method and Description
ExtAuthzOuterClass.HttpService.Builder	addAllResponseHeadersToRemove(Iterable<String> values) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
ExtAuthzOuterClass.HttpService.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExtAuthzOuterClass.HttpService.Builder	addResponseHeadersToRemove(String value) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
ExtAuthzOuterClass.HttpService.Builder	addResponseHeadersToRemoveBytes(com.google.protobuf.ByteString value) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
ExtAuthzOuterClass.HttpService	build()
ExtAuthzOuterClass.HttpService	buildPartial()
ExtAuthzOuterClass.HttpService.Builder	clear()
ExtAuthzOuterClass.HttpService.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ExtAuthzOuterClass.HttpService.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ExtAuthzOuterClass.HttpService.Builder	clearPathPrefix() Sets an optional prefix to the value of authorization request header `path`.
ExtAuthzOuterClass.HttpService.Builder	clearResponseHeadersToRemove() Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
ExtAuthzOuterClass.HttpService.Builder	clearServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
ExtAuthzOuterClass.HttpService.Builder	clone()
ExtAuthzOuterClass.HttpService	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getPathPrefix() Sets an optional prefix to the value of authorization request header `path`.
com.google.protobuf.ByteString	getPathPrefixBytes() Sets an optional prefix to the value of authorization request header `path`.
String	getResponseHeadersToRemove(int index) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
com.google.protobuf.ByteString	getResponseHeadersToRemoveBytes(int index) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
int	getResponseHeadersToRemoveCount() Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
com.google.protobuf.ProtocolStringList	getResponseHeadersToRemoveList() Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
HttpUriOuterClass.HttpUri	getServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
HttpUriOuterClass.HttpUri.Builder	getServerUriBuilder() Sets the HTTP server URI which the authorization requests must be sent to.
HttpUriOuterClass.HttpUriOrBuilder	getServerUriOrBuilder() Sets the HTTP server URI which the authorization requests must be sent to.
boolean	hasServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ExtAuthzOuterClass.HttpService.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ExtAuthzOuterClass.HttpService.Builder	mergeFrom(ExtAuthzOuterClass.HttpService other)
ExtAuthzOuterClass.HttpService.Builder	mergeFrom(com.google.protobuf.Message other)
ExtAuthzOuterClass.HttpService.Builder	mergeServerUri(HttpUriOuterClass.HttpUri value) Sets the HTTP server URI which the authorization requests must be sent to.
ExtAuthzOuterClass.HttpService.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExtAuthzOuterClass.HttpService.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExtAuthzOuterClass.HttpService.Builder	setPathPrefix(String value) Sets an optional prefix to the value of authorization request header `path`.
ExtAuthzOuterClass.HttpService.Builder	setPathPrefixBytes(com.google.protobuf.ByteString value) Sets an optional prefix to the value of authorization request header `path`.
ExtAuthzOuterClass.HttpService.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ExtAuthzOuterClass.HttpService.Builder	setResponseHeadersToRemove(int index, String value) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
ExtAuthzOuterClass.HttpService.Builder	setServerUri(HttpUriOuterClass.HttpUri.Builder builderForValue) Sets the HTTP server URI which the authorization requests must be sent to.
ExtAuthzOuterClass.HttpService.Builder	setServerUri(HttpUriOuterClass.HttpUri value) Sets the HTTP server URI which the authorization requests must be sent to.
ExtAuthzOuterClass.HttpService.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

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

clear

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

getDefaultInstanceForType

public ExtAuthzOuterClass.HttpService getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ExtAuthzOuterClass.HttpService build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ExtAuthzOuterClass.HttpService buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

public ExtAuthzOuterClass.HttpService.Builder mergeFrom(ExtAuthzOuterClass.HttpService other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthzOuterClass.HttpService.Builder>

mergeFrom

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

Throws:

IOException

hasServerUri

public boolean hasServerUri()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

Specified by:

hasServerUri in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getServerUri

public HttpUriOuterClass.HttpUri getServerUri()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

Specified by:

getServerUri in interface ExtAuthzOuterClass.HttpServiceOrBuilder

setServerUri

public ExtAuthzOuterClass.HttpService.Builder setServerUri(HttpUriOuterClass.HttpUri value)

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

setServerUri

public ExtAuthzOuterClass.HttpService.Builder setServerUri(HttpUriOuterClass.HttpUri.Builder builderForValue)

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

mergeServerUri

public ExtAuthzOuterClass.HttpService.Builder mergeServerUri(HttpUriOuterClass.HttpUri value)

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

clearServerUri

public ExtAuthzOuterClass.HttpService.Builder clearServerUri()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

getServerUriBuilder

public HttpUriOuterClass.HttpUri.Builder getServerUriBuilder()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

getServerUriOrBuilder

public HttpUriOuterClass.HttpUriOrBuilder getServerUriOrBuilder()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

Specified by:

getServerUriOrBuilder in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getPathPrefix

public String getPathPrefix()

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

Specified by:

getPathPrefix in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getPathPrefixBytes

public com.google.protobuf.ByteString getPathPrefixBytes()

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

Specified by:

getPathPrefixBytes in interface ExtAuthzOuterClass.HttpServiceOrBuilder

setPathPrefix

public ExtAuthzOuterClass.HttpService.Builder setPathPrefix(String value)

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

clearPathPrefix

public ExtAuthzOuterClass.HttpService.Builder clearPathPrefix()

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

setPathPrefixBytes

public ExtAuthzOuterClass.HttpService.Builder setPathPrefixBytes(com.google.protobuf.ByteString value)

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

getResponseHeadersToRemoveList

public com.google.protobuf.ProtocolStringList getResponseHeadersToRemoveList()

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemoveList in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemoveCount

public int getResponseHeadersToRemoveCount()

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemoveCount in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemove

public String getResponseHeadersToRemove(int index)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemove in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemoveBytes

public com.google.protobuf.ByteString getResponseHeadersToRemoveBytes(int index)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemoveBytes in interface ExtAuthzOuterClass.HttpServiceOrBuilder

setResponseHeadersToRemove

public ExtAuthzOuterClass.HttpService.Builder setResponseHeadersToRemove(int index,
                                                                         String value)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

addResponseHeadersToRemove

public ExtAuthzOuterClass.HttpService.Builder addResponseHeadersToRemove(String value)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

addAllResponseHeadersToRemove

public ExtAuthzOuterClass.HttpService.Builder addAllResponseHeadersToRemove(Iterable<String> values)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

clearResponseHeadersToRemove

public ExtAuthzOuterClass.HttpService.Builder clearResponseHeadersToRemove()

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

addResponseHeadersToRemoveBytes

public ExtAuthzOuterClass.HttpService.Builder addResponseHeadersToRemoveBytes(com.google.protobuf.ByteString value)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

setUnknownFields

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

mergeUnknownFields

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