HttpService.Builder (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<HttpService.Builder>
    - - io.envoyproxy.envoy.extensions.filters.http.ext_authz.v4alpha.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_api_field_extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest.allowed_headers>`
 for details. Additional headers metadata may be added to the authorization request. See
 :ref:`headers_to_add
 <envoy_api_field_extensions.filters.http.ext_authz.v4alpha.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_api_field_extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse.allowed_upstream_headers>`
 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_api_field_extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse.allowed_client_headers>`
 for details.
 [#next-free-field: 9]

Protobuf type envoy.extensions.filters.http.ext_authz.v4alpha.HttpService

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpService.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`HttpService`	`build()`
`HttpService`	`buildPartial()`
`HttpService.Builder`	`clear()`
`HttpService.Builder`	`clearAuthorizationRequest()` Settings used for controlling authorization request metadata.
`HttpService.Builder`	`clearAuthorizationResponse()` Settings used for controlling authorization response metadata.
`HttpService.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`HttpService.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`HttpService.Builder`	`clearPathPrefix()` Sets a prefix to the value of authorization request header Path.
`HttpService.Builder`	`clearServerUri()` Sets the HTTP server URI which the authorization requests must be sent to.
`HttpService.Builder`	`clone()`
`AuthorizationRequest`	`getAuthorizationRequest()` Settings used for controlling authorization request metadata.
`AuthorizationRequest.Builder`	`getAuthorizationRequestBuilder()` Settings used for controlling authorization request metadata.
`AuthorizationRequestOrBuilder`	`getAuthorizationRequestOrBuilder()` Settings used for controlling authorization request metadata.
`AuthorizationResponse`	`getAuthorizationResponse()` Settings used for controlling authorization response metadata.
`AuthorizationResponse.Builder`	`getAuthorizationResponseBuilder()` Settings used for controlling authorization response metadata.
`AuthorizationResponseOrBuilder`	`getAuthorizationResponseOrBuilder()` Settings used for controlling authorization response metadata.
`HttpService`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getPathPrefix()` Sets a prefix to the value of authorization request header Path.
`com.google.protobuf.ByteString`	`getPathPrefixBytes()` Sets a prefix to the value of authorization request header Path.
`HttpUri`	`getServerUri()` Sets the HTTP server URI which the authorization requests must be sent to.
`HttpUri.Builder`	`getServerUriBuilder()` Sets the HTTP server URI which the authorization requests must be sent to.
`HttpUriOrBuilder`	`getServerUriOrBuilder()` Sets the HTTP server URI which the authorization requests must be sent to.
`boolean`	`hasAuthorizationRequest()` Settings used for controlling authorization request metadata.
`boolean`	`hasAuthorizationResponse()` Settings used for controlling authorization response metadata.
`boolean`	`hasServerUri()` Sets the HTTP server URI which the authorization requests must be sent to.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`HttpService.Builder`	`mergeAuthorizationRequest(AuthorizationRequest value)` Settings used for controlling authorization request metadata.
`HttpService.Builder`	`mergeAuthorizationResponse(AuthorizationResponse value)` Settings used for controlling authorization response metadata.
`HttpService.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`HttpService.Builder`	`mergeFrom(HttpService other)`
`HttpService.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`HttpService.Builder`	`mergeServerUri(HttpUri value)` Sets the HTTP server URI which the authorization requests must be sent to.
`HttpService.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`HttpService.Builder`	`setAuthorizationRequest(AuthorizationRequest.Builder builderForValue)` Settings used for controlling authorization request metadata.
`HttpService.Builder`	`setAuthorizationRequest(AuthorizationRequest value)` Settings used for controlling authorization request metadata.
`HttpService.Builder`	`setAuthorizationResponse(AuthorizationResponse.Builder builderForValue)` Settings used for controlling authorization response metadata.
`HttpService.Builder`	`setAuthorizationResponse(AuthorizationResponse value)` Settings used for controlling authorization response metadata.
`HttpService.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`HttpService.Builder`	`setPathPrefix(String value)` Sets a prefix to the value of authorization request header Path.
`HttpService.Builder`	`setPathPrefixBytes(com.google.protobuf.ByteString value)` Sets a prefix to the value of authorization request header Path.
`HttpService.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`HttpService.Builder`	`setServerUri(HttpUri.Builder builderForValue)` Sets the HTTP server URI which the authorization requests must be sent to.
`HttpService.Builder`	`setServerUri(HttpUri value)` Sets the HTTP server URI which the authorization requests must be sent to.
`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<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>
  - mergeFrom
```
public HttpService.Builder mergeFrom(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<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.v4alpha.HttpUri server_uri = 1;
    Specified by:
    
    hasServerUri in interface HttpServiceOrBuilder
  - getServerUri
```
public HttpUri getServerUri()
```
```
 Sets the HTTP server URI which the authorization requests must be sent to.
 
```
    .envoy.config.core.v4alpha.HttpUri server_uri = 1;
    Specified by:
    
    getServerUri in interface HttpServiceOrBuilder
  - setServerUri
```
public HttpService.Builder setServerUri(HttpUri value)
```
```
 Sets the HTTP server URI which the authorization requests must be sent to.
 
```
    .envoy.config.core.v4alpha.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.v4alpha.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.v4alpha.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.v4alpha.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.v4alpha.HttpUri server_uri = 1;
  - getServerUriOrBuilder
```
public HttpUriOrBuilder getServerUriOrBuilder()
```
```
 Sets the HTTP server URI which the authorization requests must be sent to.
 
```
    .envoy.config.core.v4alpha.HttpUri server_uri = 1;
    Specified by:
    
    getServerUriOrBuilder in interface HttpServiceOrBuilder
  - 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
  - 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
  - setPathPrefix
```
public HttpService.Builder setPathPrefix(String value)
```
```
 Sets a prefix to the value of authorization request header *Path*.
 
```
    string path_prefix = 2;
  - clearPathPrefix
```
public HttpService.Builder clearPathPrefix()
```
```
 Sets a prefix to the value of authorization request header *Path*.
 
```
    string path_prefix = 2;
  - 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;
  - hasAuthorizationRequest
```
public boolean hasAuthorizationRequest()
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest authorization_request = 7;
    Specified by:
    
    hasAuthorizationRequest in interface HttpServiceOrBuilder
  - getAuthorizationRequest
```
public AuthorizationRequest getAuthorizationRequest()
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest authorization_request = 7;
    Specified by:
    
    getAuthorizationRequest in interface HttpServiceOrBuilder
  - setAuthorizationRequest
```
public HttpService.Builder setAuthorizationRequest(AuthorizationRequest value)
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.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.v4alpha.AuthorizationRequest authorization_request = 7;
  - mergeAuthorizationRequest
```
public HttpService.Builder mergeAuthorizationRequest(AuthorizationRequest value)
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest authorization_request = 7;
  - clearAuthorizationRequest
```
public HttpService.Builder clearAuthorizationRequest()
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest authorization_request = 7;
  - getAuthorizationRequestBuilder
```
public AuthorizationRequest.Builder getAuthorizationRequestBuilder()
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest authorization_request = 7;
  - getAuthorizationRequestOrBuilder
```
public AuthorizationRequestOrBuilder getAuthorizationRequestOrBuilder()
```
```
 Settings used for controlling authorization request metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationRequest authorization_request = 7;
    Specified by:
    
    getAuthorizationRequestOrBuilder in interface HttpServiceOrBuilder
  - hasAuthorizationResponse
```
public boolean hasAuthorizationResponse()
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse authorization_response = 8;
    Specified by:
    
    hasAuthorizationResponse in interface HttpServiceOrBuilder
  - getAuthorizationResponse
```
public AuthorizationResponse getAuthorizationResponse()
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse authorization_response = 8;
    Specified by:
    
    getAuthorizationResponse in interface HttpServiceOrBuilder
  - setAuthorizationResponse
```
public HttpService.Builder setAuthorizationResponse(AuthorizationResponse value)
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.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.v4alpha.AuthorizationResponse authorization_response = 8;
  - mergeAuthorizationResponse
```
public HttpService.Builder mergeAuthorizationResponse(AuthorizationResponse value)
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse authorization_response = 8;
  - clearAuthorizationResponse
```
public HttpService.Builder clearAuthorizationResponse()
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse authorization_response = 8;
  - getAuthorizationResponseBuilder
```
public AuthorizationResponse.Builder getAuthorizationResponseBuilder()
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse authorization_response = 8;
  - getAuthorizationResponseOrBuilder
```
public AuthorizationResponseOrBuilder getAuthorizationResponseOrBuilder()
```
```
 Settings used for controlling authorization response metadata.
 
```
    .envoy.extensions.filters.http.ext_authz.v4alpha.AuthorizationResponse authorization_response = 8;
    Specified by:
    
    getAuthorizationResponseOrBuilder in interface HttpServiceOrBuilder
  - 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>

Class HttpService.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasServerUri

getServerUri

setServerUri

setServerUri

mergeServerUri

clearServerUri

getServerUriBuilder

getServerUriOrBuilder

getPathPrefix

getPathPrefixBytes

setPathPrefix

clearPathPrefix

setPathPrefixBytes

hasAuthorizationRequest

getAuthorizationRequest

setAuthorizationRequest

setAuthorizationRequest

mergeAuthorizationRequest

clearAuthorizationRequest

getAuthorizationRequestBuilder

getAuthorizationRequestOrBuilder

hasAuthorizationResponse

getAuthorizationResponse

setAuthorizationResponse

setAuthorizationResponse

mergeAuthorizationResponse

clearAuthorizationResponse

getAuthorizationResponseBuilder

getAuthorizationResponseOrBuilder

setUnknownFields

mergeUnknownFields